controlsconfig.h

Go to the documentation of this file.

/*
 * Copyright (C) Volition, Inc. 1999.  All rights reserved.
 *
 * All source code herein is the property of Volition, Inc. You may not sell 
 * or otherwise commercially exploit the source or things you created based on the 
 * source.
 *
*/ 


#ifndef CONTROLS_CONFIG_H
#define CONTROLS_CONFIG_H

#include "globalincs/pstypes.h"

#define CONTROL_CONFIG_XSTR     507

enum Joy_axis_index {
        JOY_X_AXIS              =0,
        JOY_Y_AXIS,
        JOY_Z_AXIS,
        JOY_RX_AXIS,
        JOY_RY_AXIS,
        JOY_RZ_AXIS
};


enum Joy_axis_action_index {
        JOY_HEADING_AXIS        =0,
        JOY_PITCH_AXIS,
        JOY_BANK_AXIS,
        JOY_ABS_THROTTLE_AXIS,
        JOY_REL_THROTTLE_AXIS,

        NUM_JOY_AXIS_ACTIONS                    
};



enum CC_type {
        CC_TYPE_TRIGGER                 =0,             
        CC_TYPE_CONTINUOUS                              
};

typedef struct config_item {
        short key_default;              
        short joy_default;              
        char tab;                               
        bool hasXSTR;                   
        char *text;                             
        char type;                              
        short key_id;                   
        short joy_id;                   
        int used;                               
        bool disabled;                  
        bool continuous_ongoing;
} config_item;

enum IoActionId  {
        TARGET_NEXT                                                                             =0,             
        TARGET_PREV                                                                             =1,             
        TARGET_NEXT_CLOSEST_HOSTILE                                             =2,             
        TARGET_PREV_CLOSEST_HOSTILE                                             =3,             
        TOGGLE_AUTO_TARGETING                                                   =4,             
        TARGET_NEXT_CLOSEST_FRIENDLY                                    =5,             
        TARGET_PREV_CLOSEST_FRIENDLY                                    =6,             
        TARGET_SHIP_IN_RETICLE                                                  =7,             
        TARGET_CLOSEST_SHIP_ATTACKING_TARGET                    =8,             
        TARGET_LAST_TRANMISSION_SENDER                                  =9,             
        STOP_TARGETING_SHIP                                                             =10,    

        TARGET_SUBOBJECT_IN_RETICLE                                             =11,    
        TARGET_NEXT_SUBOBJECT                                                   =12,    
        TARGET_PREV_SUBOBJECT                                                   =13,    
        STOP_TARGETING_SUBSYSTEM                                                =14,    

        MATCH_TARGET_SPEED                                                              =15,    
        TOGGLE_AUTO_MATCH_TARGET_SPEED                                  =16,    

        FIRE_PRIMARY                                                                    =17,    
        FIRE_SECONDARY                                                                  =18,    
        CYCLE_NEXT_PRIMARY                                                              =19,    
        CYCLE_PREV_PRIMARY                                                              =20,    
        CYCLE_SECONDARY                                                                 =21,    
        CYCLE_NUM_MISSLES                                                               =22,    
        LAUNCH_COUNTERMEASURE                                                   =23,    

        FORWARD_THRUST                                                                  =24,    
        REVERSE_THRUST                                                                  =25,    
        BANK_LEFT                                                                               =26,    
        BANK_RIGHT                                                                              =27,    
        PITCH_FORWARD                                                                   =28,    
        PITCH_BACK                                                                              =29,    
        YAW_LEFT                                                                                =30,    
        YAW_RIGHT                                                                               =31,    

        ZERO_THROTTLE                                                                   =32,    
        MAX_THROTTLE                                                                    =33,    
        ONE_THIRD_THROTTLE                                                              =34,    
        TWO_THIRDS_THROTTLE                                                             =35,    
        PLUS_5_PERCENT_THROTTLE                                                 =36,    
        MINUS_5_PERCENT_THROTTLE                                                =37,    

        ATTACK_MESSAGE                                                                  =38,    
        DISARM_MESSAGE                                                                  =39,    
        DISABLE_MESSAGE                                                                 =40,    
        ATTACK_SUBSYSTEM_MESSAGE                                                =41,    
        CAPTURE_MESSAGE                                                                 =42,    
        ENGAGE_MESSAGE                                                                  =43,    
        FORM_MESSAGE                                                                    =44,    
        IGNORE_MESSAGE                                                                  =45,    
        PROTECT_MESSAGE                                                                 =46,    
        COVER_MESSAGE                                                                   =47,    
        WARP_MESSAGE                                                                    =48,    
        REARM_MESSAGE                                                                   =49,    
        TARGET_CLOSEST_SHIP_ATTACKING_SELF                              =50,    

        VIEW_CHASE                                                                              =51,    
        VIEW_EXTERNAL                                                                   =52,    
        VIEW_EXTERNAL_TOGGLE_CAMERA_LOCK                                =53,    
        VIEW_SLEW                                                                               =54,    
        VIEW_OTHER_SHIP                                                                 =55,    
        VIEW_DIST_INCREASE                                                              =56,    
        VIEW_DIST_DECREASE                                                              =57,    
        VIEW_CENTER                                                                             =58,    
        PADLOCK_UP                                                                              =59,    
        PADLOCK_DOWN                                                                    =60,    
        PADLOCK_LEFT                                                                    =61,    
        PADLOCK_RIGHT                                                                   =62,    

        RADAR_RANGE_CYCLE                                                               =63,    
        SQUADMSG_MENU                                                                   =64,    
        SHOW_GOALS                                                                              =65,    
        END_MISSION                                                                             =66,    
        TARGET_TARGETS_TARGET                                                   =67,    
        AFTERBURNER                                                                             =68,    

        INCREASE_WEAPON                                                                 =69,    
        DECREASE_WEAPON                                                                 =70,    
        INCREASE_SHIELD                                                                 =71,    
        DECREASE_SHIELD                                                                 =72,    
        INCREASE_ENGINE                                                                 =73,    
        DECREASE_ENGINE                                                                 =74,    
        ETS_EQUALIZE                                                                    =75,    
        SHIELD_EQUALIZE                                                                 =76,    
        SHIELD_XFER_TOP                                                                 =77,    
        SHIELD_XFER_BOTTOM                                                              =78,    
        SHIELD_XFER_LEFT                                                                =79,    
        SHIELD_XFER_RIGHT                                                               =80,    
        XFER_SHIELD                                                                             =81,    
        XFER_LASER                                                                              =82,    

        GLIDE_WHEN_PRESSED                                                              =83,    
        BANK_WHEN_PRESSED                                                               =84,    
        SHOW_NAVMAP                                                                             =85,    
        ADD_REMOVE_ESCORT                                                               =86,    
        ESCORT_CLEAR                                                                    =87,    

        TARGET_NEXT_ESCORT_SHIP                                                 =88,    
        TARGET_CLOSEST_REPAIR_SHIP                                              =89,    
        TARGET_NEXT_UNINSPECTED_CARGO                                   =90,    
        TARGET_PREV_UNINSPECTED_CARGO                                   =91,    
        TARGET_NEWEST_SHIP                                                              =92,    

        TARGET_NEXT_LIVE_TURRET                                                 =93,    
        TARGET_PREV_LIVE_TURRET                                                 =94,    

        TARGET_NEXT_BOMB                                                                =95,    
        TARGET_PREV_BOMB                                                                =96,    

        MULTI_MESSAGE_ALL                                                               =97,    
        MULTI_MESSAGE_FRIENDLY                                                  =98,    
        MULTI_MESSAGE_HOSTILE                                                   =99,    
        MULTI_MESSAGE_TARGET                                                    =100,   

        MULTI_OBSERVER_ZOOM_TO                                                  =101,   

        TIME_SPEED_UP                                                                   =102,   
        TIME_SLOW_DOWN                                                                  =103,   

        TOGGLE_HUD_CONTRAST                                                             =104,   

        MULTI_TOGGLE_NETINFO                                                    =105,   

        MULTI_SELF_DESTRUCT                                                             =106,   

        TOGGLE_HUD                                                                              =107,   
        RIGHT_SLIDE_THRUST                                                              =108,   
        LEFT_SLIDE_THRUST                                                               =109,   
        UP_SLIDE_THRUST                                                                 =110,   
        DOWN_SLIDE_THRUST                                                               =111,   
        HUD_TARGETBOX_TOGGLE_WIREFRAME                                  =112,   
        VIEW_TOPDOWN                                                                    =113,   
        VIEW_TRACK_TARGET                                                               =114,   

        AUTO_PILOT_TOGGLE                                                               =115,   
        NAV_CYCLE                                                                               =116,   

        TOGGLE_GLIDING                                                                  =117,   

        CYCLE_PRIMARY_WEAPON_SEQUENCE                                   =118,   

        CCFG_MAX                                  
};

extern int Failed_key_index;
extern int Invert_heading;
extern int Invert_pitch;
extern int Invert_roll;
extern int Invert_thrust;
extern int Disable_axis2;
extern int Disable_axis3;

extern int Axis_map_to[];
extern int Invert_axis[];
extern int Invert_axis_defaults[];

extern int Control_config_overlay_id;

extern config_item Control_config[];            
extern SCP_vector<config_item*> Control_config_presets; // tabled control presets; pointers to config_item arrays
extern SCP_vector<SCP_string> Control_config_preset_names; // names for Control_config_presets (identical order of items)
extern char **Scan_code_text;
extern char **Joy_button_text;

void control_config_common_init();                      
void control_config_common_close();                     

void control_config_init();
void control_config_do_frame(float frametime);
void control_config_close();

void control_config_cancel_exit();

void control_config_reset_defaults(int presetnum=-1);
int translate_key_to_index(const char *key, bool find_override=true);
char *translate_key(char *key);
char *textify_scancode(int code);
float check_control_timef(int id);
int check_control(int id, int key = -1);
void control_get_axes_readings(int *h, int *p, int *b, int *ta, int *tr);
void control_used(int id);
void control_config_clear();
void clear_key_binding(short key);
void control_check_indicate();
void control_config_clear_used_status();

#endif