mission.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#define PCRE2_CODE_UNIT_WIDTH 8
#include <pcre2.h>
 
#include "claim.h"
#include "commodity.h"
#include "nlua.h"
#include "nxml.h"
#include "opengl.h"
#include "space.h"
#include "mission_markers.h"
 
/* availability by location */
typedef enum MissionAvailability_ {
   MIS_AVAIL_UNSET=-1,   
   MIS_AVAIL_NONE=0,     
   MIS_AVAIL_COMPUTER,   
   MIS_AVAIL_BAR,        
   MIS_AVAIL_LAND,       
   MIS_AVAIL_ENTER       
} MissionAvailability;
 
/* flag functions */
#define mis_isFlag(m,f)    ((m)->flags & (f))
#define mis_setFlag(m,f)   ((m)->flags |= (f))
#define mis_rmFlag(m,f)    ((m)->flags &= ~(f))
/* actual flags */
#define MISSION_UNIQUE     (1<<0) 
typedef struct MissionAvail_s {
   MissionAvailability loc; 
   int chance; 
   /* For specific cases */
   char *spob; 
   char *system; 
   char *chapter; 
   pcre2_code *chapter_re; 
   /* For generic cases */
   int *factions; 
   char *cond; 
   int cond_chunk; 
   char *done; 
   int priority; 
} MissionAvail_t;
 
typedef struct MissionData_ {
   char *name; 
   MissionAvail_t avail; 
   unsigned int flags; 
   char *lua; 
   char *sourcefile; 
   int chunk; 
   /* Tags. */
   char **tags; 
} MissionData;
 
typedef struct Mission_ {
   const MissionData *data; 
   unsigned int id; 
   int accepted; 
   char *title; 
   char *desc; 
   char *reward; 
   credits_t reward_value; 
   glTexture *portrait; 
   char *npc; 
   char *npc_desc; 
   /* mission cargo given to the player - need to cleanup */
   unsigned int *cargo; 
   /* Markers. */
   MissionMarker *markers; 
   /* OSD. */
   unsigned int osd; 
   int osd_set; 
   /* Claims. */
   Claim_t *claims; 
   nlua_env env; 
} Mission;
 
/*
 * current player missions
 */
extern Mission **player_missions; 
/*
 * creates missions for a spob and such
 */
Mission* missions_genList( int *n, int faction,
      const Spob *pnt, const StarSystem *sys, MissionAvailability loc );
int mission_accept( Mission* mission ); /* player accepted mission for computer/bar */
void missions_run( MissionAvailability loc, int faction, const Spob *pnt, const StarSystem *sys );
int mission_start( const char *name, unsigned int *id );
int mission_test( const char *name );
const char *mission_availabilityStr( MissionAvailability loc );
 
/*
 * misc
 */
const MissionData *mission_list (void);
int mission_alreadyRunning( const MissionData* misn );
int mission_getID( const char* name );
const MissionData* mission_get( int id );
const MissionData* mission_getFromName( const char* name );
int mission_addMarker( Mission *misn, int id, int sys, MissionMarkerType type );
void mission_sysMark (void);
const StarSystem* mission_sysComputerMark( const Mission* misn );
const StarSystem* mission_getSystemMarker( const Mission* misn );
MissionMarkerType mission_markerTypeSpobToSystem( MissionMarkerType t );
MissionMarkerType mission_markerTypeSystemToSpob( MissionMarkerType t );
void mission_toLuaTable( lua_State *L, const MissionData *m );
const char **mission_loadFailed (void);
 
/*
 * cargo stuff
 */
int mission_linkCargo( Mission* misn, unsigned int cargo_id );
int mission_unlinkCargo( Mission* misn, unsigned int cargo_id );
 
/*
 * load/quit
 */
int missions_load (void);
int missions_loadActive( xmlNodePtr parent );
int missions_loadCommodity( xmlNodePtr parent );
Commodity* missions_loadTempCommodity( xmlNodePtr parent );
int missions_saveActive( xmlTextWriterPtr writer );
int missions_saveTempCommodity( xmlTextWriterPtr writer, const Commodity* c );
void mission_cleanup( Mission* misn );
void mission_shift( int pos );
void missions_free (void);
void missions_cleanup (void);
int mission_reload( const char *name );
 
/*
 * Actually in nlua_misn.h
 */
int misn_tryRun( Mission *misn, const char *func );
void misn_runStart( Mission *misn, const char *func );
int misn_runFunc( const Mission *misn, const char *func, int nargs );
int misn_run( Mission *misn, const char *func );
 
/*
 * Claims.
 */
void missions_activateClaims (void);