naev/c/player_8h_source.html

/*

 * See Licensing and Copyright notice in naev.h

 */

#pragma once


#include <time.h>


#include "nstring.h"

#include "pilot.h"


enum {

   PLAYER_TURN_LEFT,

   PLAYER_TURN_RIGHT,

   PLAYER_REVERSE,

   PLAYER_ACCEL,

   PLAYER_DESTROYED,

   PLAYER_FACE,

   PLAYER_LANDACK,

   PLAYER_CREATING,

   PLAYER_AUTONAV,

   PLAYER_NOLAND,

   PLAYER_CINEMATICS,

   PLAYER_CINEMATICS_GUI,

   PLAYER_CINEMATICS_2X,

   PLAYER_HOOK_LAND,

   PLAYER_HOOK_JUMPIN,

   PLAYER_HOOK_HYPER,

   PLAYER_MFLY,

   PLAYER_NOSAVE,

   PLAYER_FLAGS_MAX

};


enum {

   PLAYER_LAND_OK,

   PLAYER_LAND_AGAIN,

   PLAYER_LAND_DENIED,

};


typedef char PlayerFlags[PLAYER_FLAGS_MAX];


/* flag functions */

#define player_isFlag( f ) ( player.flags[f] )

#define player_setFlag( f ) ( player.flags[f] = 1 )

#define player_rmFlag( f ) ( player.flags[f] = 0 )


/* Control restoration reasons. */

enum {

   PINPUT_NULL,

   PINPUT_MOVEMENT,

   PINPUT_AUTONAV,

   PINPUT_BRAKING

};


typedef struct PlayerOutfit_s {

   const Outfit *o;

   int           q;

} PlayerOutfit_t;


typedef struct PlayerShip_s {

   Pilot *p;

   PilotWeaponSet

      weapon_sets[PILOT_WEAPON_SETS];

   int autoweap;

   int favourite;


   /* Fleet data. */

   int deployed;


   /* Some meta-data. */

   double       time_played;

   char        *acquired;

   ntime_t      acquired_date;

   double       dmg_done_shield;

   double       dmg_done_armour;

   double       dmg_taken_shield;

   double       dmg_taken_armour;

   unsigned int ships_destroyed[SHIP_CLASS_TOTAL];

   unsigned int jumped_times;

   unsigned int landed_times;

   unsigned int death_counter;

} PlayerShip_t;


typedef struct Player_s {

   /* Player intrinsics. */

   Pilot       *p;

   PlayerShip_t ps;

   char        *name;


   /* Player data. */

   PlayerFlags flags;

   int         autonav;

   double      mousex;

   double      mousey;

   double

      speed;

   double speed_autonav;

   char  *chapter;

   char  *difficulty;

   int    discover_off;


   /* Loaded game version. */

   char *loaded_version;


   /* Options that we save. */

   char  *gui;

   double radar_res;

   int    eq_outfitMode;

   int    map_minimal;


   /* Player fleets. */

   int fleet_used;

   int fleet_capacity;


   /* Meta-data. */

   time_t       last_played;

   double       time_played;

   time_t       date_created;

   double       dmg_done_shield;

   double       dmg_done_armour;

   double       dmg_taken_shield;

   double       dmg_taken_armour;

   unsigned int ships_destroyed[SHIP_CLASS_TOTAL];

   unsigned int jumped_times;

   unsigned int landed_times;

   unsigned int death_counter;


   /* Meta-meta-data. */

   time_t time_since_save;

} Player_t;


/*

 * Local player.

 */

extern Player_t player;


/*

 * Common player sounds.

 */

extern int snd_target;

extern int snd_jump;

extern int snd_nav;

extern int snd_hail;

extern int snd_hypPowUp;

extern int snd_hypEng;

extern int snd_hypPowDown;

extern int snd_hypPowUpJump;

extern int snd_hypJump;


/*

 * creation/cleanup

 */

int           player_init( void );

void          player_new( void );

PlayerShip_t *player_newShip( const Ship *ship, const char *def_name, int trade,

                              const char *acquired, int noname );

void          player_cleanup( void );


/*

 * Hook voodoo.

 */

void player_runHooks( void );


/*

 * Rendering.

 */

void player_renderUnderlay( double dt );

void player_render( double dt );


/*

 * Message stuff, in gui.c

 */

void player_messageToggle( int enable );

NONNULL( 1 ) PRINTF_FORMAT( 1, 2 ) void player_message( const char *fmt, ... );

NONNULL( 1 ) void player_messageRaw( const char *str );


/*

 * Misc.

 */

void      player_resetSpeed( void );

void      player_restoreControl( int reason, const char *str );

void      player_checkLandAck( void );

void      player_nolandMsg( const char *str );

void      player_clear( void );

void      player_warp( double x, double y );

int       player_hasCredits( credits_t amount );

credits_t player_modCredits( credits_t amount );

void      player_hailStart( void );

/* Sounds. */

void player_soundPlay( int sound, int once );

void player_soundPlayGUI( int sound, int once );

void player_soundStop( void );

void player_soundPause( void );

void player_soundResume( void );


/*

 * Player ships.

 */

int                 player_ships( char **sships, glTexture **tships );

void                player_shipsSort( void );

const PlayerShip_t *player_getShipStack( void );

int                 player_nships( void );

int                 player_hasShip( const char *shipname );

Pilot              *player_getShip( const char *shipname );

PlayerShip_t       *player_getPlayerShip( const char *shipname );

void                player_swapShip( const char *shipname, int move_cargo );

credits_t           player_shipPrice( const char *shipname, int count_unique );

void                player_rmShip( const char *shipname );

void                player_rmPlayerShip( PlayerShip_t *ps );


/*

 * Player outfits.

 */

int                   player_outfitOwned( const Outfit *o );

int                   player_outfitOwnedTotal( const Outfit *o );

const PlayerOutfit_t *player_getOutfits( void );

int                   player_getOutfitsFiltered( const Outfit ***outfits,

                                                 int ( *filter )( const Outfit *o ),

                                                 const char *name );

int                   player_numOutfits( void );

int                   player_addOutfit( const Outfit *o, int quantity );

int                   player_rmOutfit( const Outfit *o, int quantity );


/*

 * Player missions.

 */

void player_missionFinished( int id );

int  player_missionAlreadyDone( int id );

int *player_missionsDoneList(

   void ); /* Returns array that should not be freed. */


/*

 * Player events.

 */

void player_eventFinished( int id );

int  player_eventAlreadyDone( int id );

int *player_eventsDoneList(

   void ); /* Returns array that should not be freed. */


/*

 * Licenses.

 */

NONNULL( 1 ) void player_addLicense( const char *license );

int          player_hasLicense( const char *license );

const char **player_getLicenses( void );


/*

 * Escorts.

 */

int player_addEscorts( void );


/*

 * Pilot related stuff.

 */

void   player_dead( void );

void   player_destroyed( void );

void   player_think( Pilot *pplayer, const double dt );

void   player_update( Pilot *pplayer, const double dt );

void   player_updateSpecific( Pilot *pplayer, const double dt );

void   player_brokeHyperspace( void );

void   player_hyperspacePreempt( int );

int    player_getHypPreempt( void );

double player_dt_default( void );


/*

 * Targeting.

 */

/* Clearing. */

void player_targetClear( void );

void player_targetClearAll( void );

/* Spobs. */

void player_targetSpobSet( int id );

void player_targetSpob( void );

/* Asteroids. */

void player_targetAsteroidSet( int id_field, int id );

/* Hyperspace. */

void player_targetHyperspaceSet( int id, int autonavcont );

void player_targetHyperspace( void );

/* Pilots. */

void player_targetSet( unsigned int id );

void player_targetHostile( void );

void player_targetNext( int mode );

void player_targetPrev( int mode );

void player_targetNearest( void );

void player_targetEscort( int prev );


/*

 * Keybind actions.

 */

void player_weapSetPress( int id, double value, int repeat );

int  player_land( int loud );

void player_approach( void );

int  player_jump( void );

void player_screenshot( void );

void player_accel( double acc );

void player_accelOver( void );

void player_hail( void );

void player_hailSpob( void );

void player_autohail( void );

void player_scan( void );

void player_toggleMouseFly( void );

void player_cooldownBrake( void );

void player_stealth( void );

player_messageRaw
void player_messageRaw(const char *str)
Adds a mesg to the queue to be displayed on screen.
Definition gui.c:293

player_message
void player_message(const char *fmt,...)
Adds a mesg to the queue to be displayed on screen.
Definition gui.c:353

player_messageToggle
void player_messageToggle(int enable)
Toggles if player should receive messages.
Definition gui.c:283

player_hailStart
void player_hailStart(void)
Starts the hail sounds and aborts autoNav.
Definition player.c:2011

player_stealth
void player_stealth(void)
Input binding for toggling stealth for the player.
Definition player.c:4824

player_weapSetPress
void player_weapSetPress(int id, double value, int repeat)
Handles keyboard events involving the player's weapon-set keys. It's valid to call this while gamepla...
Definition player.c:1491

player_eventAlreadyDone
int player_eventAlreadyDone(int id)
Checks to see if player has already completed a event.
Definition player.c:3180

player_nships
int player_nships(void)
Gets the amount of ships player has in storage.
Definition player.c:2814

snd_jump
int snd_jump
Definition player.c:104

snd_nav
int snd_nav
Definition player.c:105

player_soundResume
void player_soundResume(void)
Resumes the ship's sounds.
Definition player.c:993

player_rmOutfit
int player_rmOutfit(const Outfit *o, int quantity)
Remove an outfit from the player's outfit stack.
Definition player.c:3053

player_runHooks
void player_runHooks(void)
Runs hooks for the player.
Definition player.c:3248

player_updateSpecific
void player_updateSpecific(Pilot *pplayer, const double dt)
Does a player specific update.
Definition player.c:1395

player_getOutfitsFiltered
int player_getOutfitsFiltered(const Outfit ***outfits, int(*filter)(const Outfit *o), const char *name)
Prepares two arrays for displaying in an image array.
Definition player.c:2953

player_hasLicense
int player_hasLicense(const char *license)
Checks to see if player has license.
Definition player.c:3207

player_autohail
void player_autohail(void)
Automatically tries to hail a pilot that hailed the player.
Definition player.c:2521

player_dead
void player_dead(void)
Player got pwned.
Definition player.c:2684

player_swapShip
void player_swapShip(const char *shipname, int move_cargo)
Swaps player's current ship with their ship named shipname.
Definition player.c:590

player_cooldownBrake
void player_cooldownBrake(void)
Starts braking or active cooldown.
Definition player.c:2623

player_accel
void player_accel(double acc)
Start accelerating.
Definition player.c:2206

player_ships
int player_ships(char **sships, glTexture **tships)
Returns a buffer with all the player's ships names.
Definition player.c:2787

player_targetEscort
void player_targetEscort(int prev)
Targets the pilot.
Definition player.c:2349

player_targetAsteroidSet
void player_targetAsteroidSet(int field, int id)
Sets the player's target asteroid.
Definition player.c:1596

player_addOutfit
int player_addOutfit(const Outfit *o, int quantity)
Adds an outfit to the player outfit stack.
Definition player.c:2988

player_soundPlay
void player_soundPlay(int sound, int once)
Plays a sound at the player.
Definition player.c:958

player_new
void player_new(void)
Creates a new player.
Definition player.c:256

snd_hypJump
int snd_hypJump
Definition player.c:112

player_warp
void player_warp(double x, double y)
Warps the player to the new position.
Definition player.c:1007

snd_hypEng
int snd_hypEng
Definition player.c:109

player_checkLandAck
void player_checkLandAck(void)
Revokes landing authorization if the player's reputation is too low.
Definition player.c:1791

player_numOutfits
int player_numOutfits(void)
Gets the amount of different outfits in the player outfit stack.
Definition player.c:2976

player_targetSet
void player_targetSet(unsigned int id)
Sets the player's target.
Definition player.c:2230

player_render
void player_render(double dt)
Renders the player.
Definition player.c:1055

player_hailSpob
void player_hailSpob(void)
Opens communication with the player's spob target.
Definition player.c:2503

player_shipPrice
credits_t player_shipPrice(const char *shipname, int count_unique)
Calculates the price of one of the player's ships.
Definition player.c:733

player_resetSpeed
void player_resetSpeed(void)
Resets the player speed stuff.
Definition player.c:1521

player_getShipStack
const PlayerShip_t * player_getShipStack(void)
Gets the array (array.h) of the player's ships.
Definition player.c:2804

player_targetHyperspaceSet
void player_targetHyperspaceSet(int id, int nomsg)
Sets the player's hyperspace target.
Definition player.c:1905

snd_hail
int snd_hail
Definition player.c:106

player_cleanup
void player_cleanup(void)
Cleans up player stuff like player_stack.
Definition player.c:800

player_targetHyperspace
void player_targetHyperspace(void)
Gets a hyperspace target.
Definition player.c:1940

snd_hypPowDown
int snd_hypPowDown
Definition player.c:110

player_newShip
PlayerShip_t * player_newShip(const Ship *ship, const char *def_name, int trade, const char *acquired, int noname)
Creates a new ship for player.
Definition player.c:470

player_rmShip
void player_rmShip(const char *shipname)
Removes one of the player's ships.
Definition player.c:775

player_outfitOwnedTotal
int player_outfitOwnedTotal(const Outfit *o)
Definition player.c:2912

player_hyperspacePreempt
void player_hyperspacePreempt(int preempt)
Enables or disables jump points preempting spobs in autoface and target clearing.
Definition player.c:1980

player_getPlayerShip
PlayerShip_t * player_getPlayerShip(const char *shipname)
Gets a specific ship.
Definition player.c:2863

player_toggleMouseFly
void player_toggleMouseFly(void)
Toggles mouse flying.
Definition player.c:2601

player_targetNearest
void player_targetNearest(void)
Player targets nearest pilot.
Definition player.c:2393

player_dt_default
double player_dt_default(void)
Returns the player's total default time delta based on time dilation stuff.
Definition player.c:2001

player_update
void player_update(Pilot *pplayer, const double dt)
Player update function.
Definition player.c:1379

player_getLicenses
const char ** player_getLicenses()
Gets the array (array.h) of license names in the player's inventory.
Definition player.c:3240

player_brokeHyperspace
void player_brokeHyperspace(void)
Player actually broke hyperspace (entering new system).
Definition player.c:2102

player_getHypPreempt
int player_getHypPreempt(void)
Returns whether the jump point target should preempt the spob target.
Definition player.c:1990

player_missionAlreadyDone
int player_missionAlreadyDone(int id)
Checks to see if player has already completed a mission.
Definition player.c:3125

player_renderUnderlay
void player_renderUnderlay(double dt)
Renders the player underlay.
Definition player.c:1099

player_addEscorts
int player_addEscorts(void)
Adds the player's escorts.
Definition player.c:3288

player_soundStop
void player_soundStop(void)
Stops playing player sounds.
Definition player.c:966

player_restoreControl
void player_restoreControl(int reason, const char *str)
Aborts autonav and other states that take control of the ship.
Definition player.c:1535

player_addLicense
void player_addLicense(const char *license)
Gives the player a license.
Definition player.c:3225

player_modCredits
credits_t player_modCredits(credits_t amount)
Modifies the amount of credits the player has.
Definition player.c:1047

player_eventsDoneList
int * player_eventsDoneList(void)
Gets a list of all the events the player has done.
Definition player.c:3196

snd_hypPowUpJump
int snd_hypPowUpJump
Definition player.c:111

player_jump
int player_jump(void)
Actually attempts to jump in hyperspace.
Definition player.c:2029

player_targetSpobSet
void player_targetSpobSet(int id)
Sets the player's target spob.
Definition player.c:1559

player_clear
void player_clear(void)
Clears the targets.
Definition player.c:1019

snd_hypPowUp
int snd_hypPowUp
Definition player.c:108

player_hasShip
int player_hasShip(const char *shipname)
Sees if player has a ship of a name.
Definition player.c:2825

player_accelOver
void player_accelOver(void)
Done accelerating.
Definition player.c:2220

player_think
void player_think(Pilot *pplayer, const double dt)
Basically uses keyboard input instead of AI input. Used in pilot.c.
Definition player.c:1252

snd_target
int snd_target
Definition player.c:103

player_land
int player_land(int loud)
Try to land or target closest spob if no land target.
Definition player.c:1653

player_soundPause
void player_soundPause(void)
Pauses the ship's sounds.
Definition player.c:982

player
Player_t player
Definition player.c:77

player_hasCredits
int player_hasCredits(credits_t amount)
Checks to see if the player has enough credits.
Definition player.c:1036

player_shipsSort
void player_shipsSort(void)
Sorts the players ships.
Definition player.c:2769

player_missionFinished
void player_missionFinished(int id)
Marks a mission as completed.
Definition player.c:3094

player_outfitOwned
int player_outfitOwned(const Outfit *o)
Gets how many of the outfit the player owns.
Definition player.c:2882

player_targetClearAll
void player_targetClearAll(void)
Clears all player targets: hyperspace, spob, asteroid, etc...
Definition player.c:2336

player_nolandMsg
void player_nolandMsg(const char *str)
Sets the no land message.
Definition player.c:1822

player_targetPrev
void player_targetPrev(int mode)
Cycles to previous target.
Definition player.c:2307

player_getOutfits
const PlayerOutfit_t * player_getOutfits(void)
Gets an array (array.h) of the player's outfits.
Definition player.c:2940

player_soundPlayGUI
void player_soundPlayGUI(int sound, int once)
Plays a GUI sound (unaffected by time accel).
Definition player.c:947

player_targetClear
void player_targetClear(void)
Clears the player's ship, spob or hyperspace target, in that order.
Definition player.c:2315

player_targetHostile
void player_targetHostile(void)
Targets the nearest hostile enemy to the player.
Definition player.c:2258

player_eventFinished
void player_eventFinished(int id)
Marks a event as completed.
Definition player.c:3151

player_screenshot
void player_screenshot(void)
Takes a screenshot.
Definition player.c:2415

player_approach
void player_approach(void)
Logic to make the player approach a target pilot to board or spob to land on.
Definition player.c:1839

player_destroyed
void player_destroyed(void)
Player blew up in a fireball.
Definition player.c:2698

player_targetSpob
void player_targetSpob(void)
Cycle through spob targets.
Definition player.c:1620

player_init
int player_init(void)
Initializes player stuff.
Definition player.c:199

player_missionsDoneList
int * player_missionsDoneList(void)
Gets a list of all the missions the player has done.
Definition player.c:3141

player_getShip
Pilot * player_getShip(const char *shipname)
Gets a specific ship.
Definition player.c:2844

player_targetNext
void player_targetNext(int mode)
Cycles to next target.
Definition player.c:2297

player_hail
void player_hail(void)
Opens communication with the player's target.
Definition player.c:2476

Outfit
A ship outfit, depends radically on the type.
Definition outfit.h:372

PilotWeaponSet
A weapon set represents a set of weapons that have an action.
Definition pilot.h:207

Pilot
The representation of an in-game pilot.
Definition pilot.h:263

PlayerOutfit_t
Wrapper for outfits.
Definition player.h:64

PlayerOutfit_t::o
const Outfit * o
Definition player.h:65

PlayerOutfit_t::q
int q
Definition player.h:66

PlayerShip_t
Player ship.
Definition player.h:72

PlayerShip_t::time_played
double time_played
Definition player.h:83

PlayerShip_t::dmg_done_armour
double dmg_done_armour
Definition player.h:87

PlayerShip_t::death_counter
unsigned int death_counter
Definition player.h:94

PlayerShip_t::dmg_taken_armour
double dmg_taken_armour
Definition player.h:89

PlayerShip_t::acquired_date
ntime_t acquired_date
Definition player.h:85

PlayerShip_t::deployed
int deployed
Definition player.h:80

PlayerShip_t::dmg_taken_shield
double dmg_taken_shield
Definition player.h:88

PlayerShip_t::landed_times
unsigned int landed_times
Definition player.h:93

PlayerShip_t::p
Pilot * p
Definition player.h:73

PlayerShip_t::autoweap
int autoweap
Definition player.h:76

PlayerShip_t::ships_destroyed
unsigned int ships_destroyed[SHIP_CLASS_TOTAL]
Definition player.h:90

PlayerShip_t::acquired
char * acquired
Definition player.h:84

PlayerShip_t::jumped_times
unsigned int jumped_times
Definition player.h:92

PlayerShip_t::weapon_sets
PilotWeaponSet weapon_sets[PILOT_WEAPON_SETS]
Definition player.h:75

PlayerShip_t::dmg_done_shield
double dmg_done_shield
Definition player.h:86

PlayerShip_t::favourite
int favourite
Definition player.h:77

Player_t
Definition player.h:100

Player_t::p
Pilot * p
Definition player.h:102

Player_t::radar_res
double radar_res
Definition player.h:123

Player_t::dmg_done_shield
double dmg_done_shield
Definition player.h:135

Player_t::mousex
double mousex
Definition player.h:109

Player_t::autonav
int autonav
Definition player.h:108

Player_t::jumped_times
unsigned int jumped_times
Definition player.h:141

Player_t::ps
PlayerShip_t ps
Definition player.h:103

Player_t::name
char * name
Definition player.h:104

Player_t::loaded_version
char * loaded_version
Definition player.h:119

Player_t::dmg_done_armour
double dmg_done_armour
Definition player.h:136

Player_t::ships_destroyed
unsigned int ships_destroyed[SHIP_CLASS_TOTAL]
Definition player.h:139

Player_t::fleet_used
int fleet_used
Definition player.h:128

Player_t::last_played
time_t last_played
Definition player.h:132

Player_t::dmg_taken_armour
double dmg_taken_armour
Definition player.h:138

Player_t::gui
char * gui
Definition player.h:122

Player_t::speed_autonav
double speed_autonav
Definition player.h:113

Player_t::time_since_save
time_t time_since_save
Definition player.h:146

Player_t::map_minimal
int map_minimal
Definition player.h:125

Player_t::time_played
double time_played
Definition player.h:133

Player_t::chapter
char * chapter
Definition player.h:114

Player_t::date_created
time_t date_created
Definition player.h:134

Player_t::fleet_capacity
int fleet_capacity
Definition player.h:129

Player_t::dmg_taken_shield
double dmg_taken_shield
Definition player.h:137

Player_t::speed
double speed
Definition player.h:112

Player_t::difficulty
char * difficulty
Definition player.h:115

Player_t::mousey
double mousey
Definition player.h:110

Player_t::death_counter
unsigned int death_counter
Definition player.h:143

Player_t::flags
PlayerFlags flags
Definition player.h:107

Player_t::discover_off
int discover_off
Definition player.h:116

Player_t::landed_times
unsigned int landed_times
Definition player.h:142

Player_t::eq_outfitMode
int eq_outfitMode
Definition player.h:124

Ship
Represents a space ship.
Definition ship.h:97

glTexture
Abstraction for rendering sprite sheets.
Definition opengl_tex.h:43