hook.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include "nlua_asteroid.h"
#include "nlua_faction.h"
#include "nlua_jump.h"
#include "nlua_pilot.h"
#include "nlua_spob.h"
#include "nlua_system.h"
 
#define HOOK_MAX_PARAM                                                         \
   7 

typedef enum HookParamType_e {
   HOOK_PARAM_NIL,       
   HOOK_PARAM_NUMBER,    
   HOOK_PARAM_STRING,    
   HOOK_PARAM_BOOL,      
   HOOK_PARAM_PILOT,     
   HOOK_PARAM_SHIP,      
   HOOK_PARAM_OUTFIT,    
   HOOK_PARAM_COMMODITY, 
   HOOK_PARAM_FACTION,   
   HOOK_PARAM_SSYS,      
   HOOK_PARAM_SPOB,      
   HOOK_PARAM_JUMP,      
   HOOK_PARAM_ASTEROID,  
   HOOK_PARAM_REF,       
   HOOK_PARAM_SENTINEL   
} HookParamType;

typedef struct HookParam_s {
   HookParamType type; 
   union {
      double        num;       
      const char   *str;       
      int           b;         
      LuaPilot      lp;        
      const Ship   *ship;      
      const Outfit *outfit;    
      Commodity    *commodity; 
      LuaFaction    lf;        
      LuaSystem     ls;        
      LuaSpob       la;        
      LuaJump       lj;        
      LuaAsteroid_t ast;       
      int           ref;       
   } u;                        
} HookParam;
 
/*
 * Exclusion.
 */
void hook_exclusionStart( void );
void hook_exclusionEnd( double dt );
 
/* add/run hooks */
unsigned int hook_addMisn( unsigned int parent, const char *func,
                           const char *stack );
unsigned int hook_addEvent( unsigned int parent, const char *func,
                            const char *stack );
unsigned int hook_addFunc( int ( *func )( void * ), void *data,
                           const char *stack );
void         hook_rm( unsigned int id );
void         hook_rmMisnParent( unsigned int parent );
void         hook_rmEventParent( unsigned int parent );
int          hook_hasMisnParent( unsigned int parent );
int          hook_hasEventParent( unsigned int parent );
 
/* pilot hook. Weird dependencies don't let us put it into pilot_hook.h */
int      pilot_runHookParam( Pilot *p, int hook_type, const HookParam *param,
                             int nparam );
nlua_env hook_env( unsigned int hook );
 
/*
 * run hooks
 *
 * Currently used:
 *  - General
 *    - "safe" - Runs once each frame at a same time (last in the frame), good
 * place to do breaking stuff.
 *    - "takeoff" - When taking off
 *    - "jumpin" - When player jumps (after changing system)
 *    - "jumpout" - When player jumps (before changing system)
 *    - "time" - When time is increment drastically (hyperspace and taking off)
 *    - "hail" - When any pilot is hailed
 *    - "hail_spob" - When any spob is hailed
 *    - "board" - When any pilot is boarded
 *    - "input" - When an input command is pressed
 *    - "standing" - Whenever faction changes.
 *    - "load" - Run on load.
 *    - "discover" - When something is discovered.
 *    - "pay" - When player receives or loses money.
 *  - Landing
 *    - "land" - When landed
 *    - "outfits" - When visited outfitter
 *    - "shipyard" - When visited shipyard
 *    - "bar" - When visited bar
 *    - "mission" - When visited mission computer
 *    - "commodity" - When visited commodity exchange
 *    - "equipment" - When visiting equipment place < br/>
 */
int hooks_runParamDeferred( const char *stack, const HookParam *param );
int hooks_runParam( const char *stack, const HookParam *param );
int hooks_run( const char *stack );
int hook_runIDparam( unsigned int id, const HookParam *param );
int hook_runID( unsigned int id ); /* runs hook of specific id */
 
/* Destroys hooks */
void hook_cleanup( void ); /* Frees memory. */
void hook_clear( void );
void hook_clearMissionTimers( unsigned int parent );
void hook_clearEventTimers( unsigned int parent );
 
/* Timer hooks. */
void         hooks_update( double dt );
unsigned int hook_addTimerMisn( unsigned int parent, const char *func,
                                double ms );
unsigned int hook_addTimerEvt( unsigned int parent, const char *func,
                               double ms );
unsigned int hook_addTimerFunc( int ( *func )( void * ), void *data,
                                double ms );
 
/* Date hooks. */
void         hooks_updateDate( ntime_t change );
unsigned int hook_addDateMisn( unsigned int parent, const char *func,
                               ntime_t resolution );
unsigned int hook_addDateEvt( unsigned int parent, const char *func,
                              ntime_t resolution );