npc.c

Go to the documentation of this file.

/*
 * See Licensing and Copyright notice in naev.h
 */
#include <lua.h>
 
#include "npc.h"
 
#include "array.h"
#include "land.h"
#include "log.h"
#include "ndata.h"
#include "nlua_evt.h"
#include "nlua_tex.h"
#include "ntracing.h"

typedef enum NPCtype_ {
   NPC_TYPE_NULL,    
   NPC_TYPE_GIVER,   
   NPC_TYPE_MISSION, 
   NPC_TYPE_EVENT    
} NPCtype;

typedef struct NPCevtData_ {
   unsigned int id;   
   char        *func; 
} NPCevtData;

typedef struct NPCmisnData_ {
   unsigned int id;   
   char        *func; 
} NPCmisnData;

typedef struct NPC_s {
   unsigned int id;   
   NPCtype      type; 
   int priority; 
   char      *name;       
   glTexture *portrait;   
   glTexture *background; 
   char      *desc;       
   union {
      NPCmisnData m; 
      NPCevtData  e; 
   } u;              
} NPC_t;
 
static unsigned int npc_array_idgen = 0; 
static NPC_t       *npc_array = NULL;    
 
/* We have to store the missions temporarily here. */
static Mission *npc_missions = NULL;
 
/*
 * Prototypes.
 */
/* NPCs. */
static unsigned int npc_add( NPC_t *npc );
static int          npc_rm( NPC_t *npc );
static NPC_t       *npc_arrayGet( unsigned int id );
static void         npc_free( NPC_t *npc );
/* Missions. */
static Mission *npc_getMisn( const NPC_t *npc );

static Mission *npc_getMisn( const NPC_t *npc )
{
   /* First check active missions. */
   for ( int i = 0; i < array_size( player_missions ); i++ )
      if ( player_missions[i]->id == npc->u.m.id )
         return player_missions[i];
 
   /* Now check npc missions. */
   for ( int i = 0; i < array_size( npc_missions ); i++ )
      if ( npc_missions[i].id == npc->u.m.id )
         return &npc_missions[i];
 
   return NULL;
}

static unsigned int npc_add( NPC_t *npc )
{
   NPC_t *new_npc;
 
   /* Must be landed. */
   if ( !landed ) {
      npc_free( npc );
      return 0;
   }
 
   /* Create if needed. */
   if ( npc_array == NULL )
      npc_array = array_create( NPC_t );
 
   /* Grow. */
   new_npc = &array_grow( &npc_array );
 
   /* Copy over. */
   *new_npc = *npc;
 
   /* Set ID. */
   new_npc->id = ++npc_array_idgen;
   return new_npc->id;
}

static unsigned int npc_add_giver( Mission *misn )
{
   NPC_t npc;
 
   /* Sanity check. */
   if ( misn->npc == NULL ) {
      WARN( _( "Mission '%s' trying to create NPC with no name!" ),
            misn->data->name );
      return 0;
   }
   if ( misn->portrait == NULL ) {
      WARN( _( "Mission '%s' trying to create NPC with no portrait!" ),
            misn->data->name );
      return 0;
   }
   if ( misn->npc_desc == NULL ) {
      WARN( _( "Mission '%s' trying to create NPC with no description!" ),
            misn->data->name );
      return 0;
   }
 
   /* Set up the data. */
   npc.type       = NPC_TYPE_GIVER;
   npc.name       = strdup( misn->npc );
   npc.priority   = misn->data->avail.priority;
   npc.portrait   = gl_dupTexture( misn->portrait );
   npc.background = NULL;
   npc.desc       = strdup( misn->npc_desc );
   npc.u.m.id     = misn->id;
   npc.u.m.func   = strdup( "accept" );
 
   return npc_add( &npc );
}

unsigned int npc_add_mission( unsigned int mid, const char *func,
                              const char *name, int priority,
                              glTexture *portrait, const char *desc,
                              glTexture *background )
{
   NPC_t npc;
 
   /* The data. */
   npc.type       = NPC_TYPE_MISSION;
   npc.name       = strdup( name );
   npc.priority   = priority;
   npc.portrait   = portrait;
   npc.background = background;
   npc.desc       = strdup( desc );
   npc.u.m.id     = mid;
   npc.u.m.func   = strdup( func );
 
   return npc_add( &npc );
}

unsigned int npc_add_event( unsigned int evt, const char *func,
                            const char *name, int priority, glTexture *portrait,
                            const char *desc, glTexture *background )
{
   NPC_t npc;
 
   /* The data. */
   npc.type       = NPC_TYPE_EVENT;
   npc.name       = strdup( name );
   npc.priority   = priority;
   npc.portrait   = portrait;
   npc.background = background;
   npc.desc       = strdup( desc );
   npc.u.e.id     = evt;
   npc.u.e.func   = strdup( func );
 
   return npc_add( &npc );
}

static int npc_rm( NPC_t *npc )
{
   if ( npc == NULL )
      return 0;
   npc_free( npc );
   array_erase( &npc_array, &npc[0], &npc[1] );
   return 0;
}

static NPC_t *npc_arrayGet( unsigned int id )
{
   for ( int i = 0; i < array_size( npc_array ); i++ )
      if ( npc_array[i].id == id )
         return &npc_array[i];
   return NULL;
}

int npc_rm_event( unsigned int id, unsigned int evt )
{
   /* Get the NPC. */
   NPC_t *npc = npc_arrayGet( id );
   if ( npc == NULL )
      return -1;
 
   /* Doesn't match type. */
   if ( npc->type != NPC_TYPE_EVENT )
      return -1;
 
   /* Doesn't belong to the event.. */
   if ( npc->u.e.id != evt )
      return -1;
 
   /* Remove the NPC. */
   return npc_rm( npc );
}

int npc_rm_mission( unsigned int id, unsigned int mid )
{
   /* Get the NPC. */
   NPC_t *npc = npc_arrayGet( id );
   if ( npc == NULL )
      return -1;
 
   /* Doesn't match type. */
   if ( npc->type != NPC_TYPE_MISSION )
      return -1;
 
   /* Doesn't belong to the mission. */
   if ( mid != npc->u.m.id )
      return -1;
 
   /* Remove the NPC. */
   return npc_rm( npc );
}

int npc_rm_parentEvent( unsigned int id )
{
   int n = 0;
   for ( int i = 0; i < array_size( npc_array ); i++ ) {
      NPC_t *npc = &npc_array[i];
      if ( npc->type != NPC_TYPE_EVENT )
         continue;
      if ( npc->u.e.id != id )
         continue;
 
      /* Invalidates iterators. */
      npc_rm( npc );
      i--;
      n++;
   }
 
   bar_regen();
 
   return n;
}

int npc_rm_parentMission( unsigned int mid )
{
   int n = 0;
   for ( int i = 0; i < array_size( npc_array ); i++ ) {
      NPC_t *npc = &npc_array[i];
      if ( npc->type != NPC_TYPE_MISSION )
         continue;
      if ( npc->u.m.id != mid )
         continue;
 
      /* Invalidates iterators. */
      npc_rm( npc );
      i--;
      n++;
   }
 
   bar_regen();
 
   return n;
}

static int npc_compare( const void *arg1, const void *arg2 )
{
   const NPC_t *npc1, *npc2;
   int          ret;
 
   npc1 = (NPC_t *)arg1;
   npc2 = (NPC_t *)arg2;
 
   /* Compare priority. */
   if ( npc1->priority > npc2->priority )
      return +1;
   else if ( npc1->priority < npc2->priority )
      return -1;
 
   /* Compare name. */
   ret = strcmp( npc1->name, npc2->name );
   if ( ret != 0 )
      return ret;
 
   /* Compare ID. */
   if ( npc1->id > npc2->id )
      return +1;
   else if ( npc1->id < npc2->id )
      return -1;
   return 0;
}

void npc_sort( void )
{
   if ( npc_array != NULL )
      qsort( npc_array, array_size( npc_array ), sizeof( NPC_t ), npc_compare );
}

void npc_generateMissions( void )
{
   Mission *missions;
 
   NTracingZone( _ctx, 1 );
 
   if ( npc_missions == NULL )
      npc_missions = array_create( Mission );
 
   /* Get the missions. */
   missions = missions_genList( land_spob->presence.faction, land_spob,
                                cur_system, MIS_AVAIL_BAR );
   /* Mission sshould already be generated and have had their 'create' function
    * run, so NPCs should be running wild (except givers). */
 
   /* Add to the bar NPC stack and add npc. */
   for ( int i = 0; i < array_size( missions ); i++ ) {
      Mission *m = &missions[i];
      array_push_back( &npc_missions, *m );
 
      /* See if need to add NPC. */
      if ( m->npc )
         npc_add_giver( m );
 
#if DEBUGGING
      /* Make sure the mission has created an NPC or it won't be able to do
       * anything. */
      int    found = 0;
      NPC_t *npc;
      for ( int j = 0; j < array_size( npc_array ); j++ ) {
         npc = &npc_array[j];
         if ( ( npc->type == NPC_TYPE_MISSION ||
                npc->type == NPC_TYPE_GIVER ) &&
              npc->u.m.id == m->id ) {
            found = 1;
            break;
         }
      }
      if ( !found )
         WARN( _( "Mission '%s' was created at the spaceport bar but didn't "
                  "create any NPC!" ),
               m->data->name );
#endif /* DEBUGGING */
   }
 
   /* Clean up. */
   array_free( missions );
 
   /* Sort NPC. */
   npc_sort();
 
   NTracingZoneEnd( _ctx );
}

void npc_patchMission( Mission *misn )
{
   if ( npc_missions == NULL )
      npc_missions = array_create( Mission );
 
   /* Add to array. */
   array_push_back( &npc_missions, *misn );
 
   /* Add mission giver if necessary. */
   if ( misn->npc )
      npc_add_giver( misn );
 
   /* Sort NPC. */
   npc_sort();
}

static void npc_free( NPC_t *npc )
{
   /* Common free stuff. */
   if ( npc == NULL )
      return;
   free( npc->name );
   gl_freeTexture( npc->portrait );
   if ( npc->background != NULL )
      gl_freeTexture( npc->background );
   free( npc->desc );
 
   /* Type-specific free stuff. */
   switch ( npc->type ) {
   case NPC_TYPE_GIVER:
   case NPC_TYPE_MISSION:
      free( npc->u.m.func );
      break;
 
   case NPC_TYPE_EVENT:
      free( npc->u.e.func );
      break;
 
   default:
      WARN( _( "Freeing NPC of invalid type." ) );
      return;
   }
}

void npc_clear( void )
{
   /* Clear the npcs. */
   for ( int i = 0; i < array_size( npc_array ); i++ )
      npc_free( &npc_array[i] );
   array_free( npc_array );
   npc_array = NULL;
 
   /* Clear all the missions. */
   for ( int i = 0; i < array_size( npc_missions ); i++ ) {
      int j;
      /* TODO this is horrible and should be removed */
      /* Clean up all missions that haven't been moved to the active missions.
       */
      for ( j = 0; j < array_size( player_missions ); j++ )
         if ( player_missions[j]->id == npc_missions[i].id )
            break;
      if ( j >= array_size( player_missions ) )
         mission_cleanup( &npc_missions[i] );
   }
   array_free( npc_missions );
   npc_missions = NULL;
}

int npc_getArraySize( void )
{
   return array_size( npc_array );
}

const char *npc_getName( int i )
{
   /* Make sure in bounds. */
   if ( i < 0 || npc_array == NULL || i >= array_size( npc_array ) )
      return NULL;
 
   return npc_array[i].name;
}

glTexture *npc_getBackground( int i )
{
   NPC_t *npc;
 
   /* Make sure in bounds. */
   if ( i < 0 || npc_array == NULL || i >= array_size( npc_array ) )
      return NULL;
   npc = &npc_array[i];
 
   /* TODO choose the background based on the spob or something. */
   if ( npc->background == NULL ) {
      if ( land_spob->lua_barbg != LUA_NOREF ) {
         spob_luaInitMem( land_spob );
         lua_rawgeti( naevL, LUA_REGISTRYINDEX, land_spob->lua_barbg ); /* f */
         if ( nlua_pcall( land_spob->lua_env, 0, 1 ) ) {
            WARN( _( "Spob '%s' failed to run '%s':\n%s" ), land_spob->name,
                  "barbg", lua_tostring( naevL, -1 ) );
            lua_pop( naevL, 1 );
         }
 
         if ( lua_istex( naevL, -1 ) )
            npc->background = gl_dupTexture( lua_totex( naevL, -1 ) );
         else
            WARN( _( "Spob '%s''s '%s' did not return a texture!" ),
                  land_spob->name, "barbg" );
         lua_pop( naevL, 1 );
      }
      if ( npc->background == NULL )
         npc->background =
            gl_newImage( GFX_PATH "portraits/background.png", 0 );
   }
 
   return npc->background;
}

glTexture *npc_getTexture( int i )
{
   /* Make sure in bounds. */
   if ( i < 0 || npc_array == NULL || i >= array_size( npc_array ) )
      return NULL;
 
   return npc_array[i].portrait;
}

const char *npc_getDesc( int i )
{
   /* Make sure in bounds. */
   if ( i < 0 || npc_array == NULL || i >= array_size( npc_array ) )
      return NULL;
 
   return npc_array[i].desc;
}

int npc_isImportant( int i )
{
   /* Make sure in bounds. */
   if ( i < 0 || npc_array == NULL || i >= array_size( npc_array ) )
      return 0;
 
   if ( npc_array[i].priority <= 5 )
      return 1;
   return 0;
}

static int npc_approach_giver( NPC_t *npc )
{
   int          ret;
   Mission     *misn;
   unsigned int id;
 
   /* Get mission. */
   misn = npc_getMisn( npc );
   if ( misn == NULL ) {
      WARN(
         _( "Unable to find mission '%d' in npc_missions for giver npc '%s'!" ),
         npc->u.m.id, npc->name );
      return -1;
   }
   id  = npc->id;
   ret = mission_accept( misn );
   if ( ( ret == 3 ) || ( ret == 2 ) ||
        ( ret == -1 ) ) { /* success in accepting the mission */
      if ( ret == -1 )
         mission_cleanup( misn );
      npc_rm( npc_arrayGet( id ) );
      ret = 1;
   } else
      ret = 0;
 
   return ret;
}

int npc_approach( int i )
{
   NPC_t   *npc;
   Mission *misn;
 
   /* Make sure in bounds. */
   if ( i < 0 || i >= array_size( npc_array ) )
      return -1;
 
   /* Comfortability. */
   npc = &npc_array[i];
 
   /* Handle type. */
   switch ( npc->type ) {
   case NPC_TYPE_GIVER:
      return npc_approach_giver( npc );
 
   case NPC_TYPE_MISSION:
      misn = npc_getMisn( npc );
      if ( misn == NULL ) {
         WARN( _( "Unable to find mission '%d' in npc_missions for mission npc "
                  "'%s'!" ),
               npc->u.m.id, npc->name );
         return -1;
      }
      misn_runStart( misn, npc->u.m.func );
      lua_pushnumber( naevL, npc->id );
      misn_runFunc( misn, npc->u.m.func, 1 );
      break;
 
   case NPC_TYPE_EVENT:
      event_runStart( npc->u.e.id, npc->u.e.func );
      lua_pushnumber( naevL, npc->id );
      event_runFunc( npc->u.e.id, npc->u.e.func, 1 );
      break;
 
   default:
      WARN( _( "Unknown NPC type!" ) );
      return -1;
   }
 
   return 0;
}