Difference between revisions of "Controlconfigdefaults.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Documented $Disable)
(Add notes on entries that are only valid for the first ControlConfigOverride block)
Line 61: Line 61:
 
*Valid entries: TARGET_TAB, SHIP_TAB, WEAPON_TAB, COMPUTER_TAB
 
*Valid entries: TARGET_TAB, SHIP_TAB, WEAPON_TAB, COMPUTER_TAB
 
*Optional
 
*Optional
 +
*'''Valid for only the first #ControlConfigOverride block'''
 
*Syntax: '''String'''
 
*Syntax: '''String'''
  
Line 67: Line 68:
 
*'''1''' for yes, '''0''' for no
 
*'''1''' for yes, '''0''' for no
 
*Optional
 
*Optional
 +
*'''Valid for only the first #ControlConfigOverride block'''
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
  
Line 78: Line 80:
 
**Control that activates when the key/button is held down, and stays activated until the key/button is released. Ex: Afterburner key.
 
**Control that activates when the key/button is held down, and stays activated until the key/button is released. Ex: Afterburner key.
 
*Optional
 
*Optional
 +
*'''Valid for only the first #ControlConfigOverride block'''
 
*Syntax '''String'''
 
*Syntax '''String'''
  
Line 83: Line 86:
 
{{Table373|
 
{{Table373|
 
*Determines whether the binding can be used and appears in the options menu. Can be used to hide bindings which are not needed, or to enable bindings which are hidden by default.
 
*Determines whether the binding can be used and appears in the options menu. Can be used to hide bindings which are not needed, or to enable bindings which are hidden by default.
**Syntax: '''''Boolean'''''
+
* Optional
 +
*'''Valid for only the first #ControlConfigOverride block'''
 +
*Syntax: '''''Boolean'''''
 
}}
 
}}
  

Revision as of 23:05, 20 February 2017

Revision information.....

FSO Revision: 7478
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version


The controlconfigdefaults.tbl can be used to modify the default key bindings in FSO.


List of Tables

General Format

  • Begins with #ControlConfigOverride and ends with #End.
  • Only entries that you want to change are required.
  • Entries not listed will be assigned to their default/hardcoded values.
FS2 Open, 3.7.2:

Multiple #ControlConfigOverride...#End blocks can be provided. In this case, each block defines a separate control config preset, and the "Defaults" button in the control config screen can be used to cycle through them. This can be used to provide multiple pre-defined control schemes for the player to choose from (or base their personal modifications on). If used, it's a good idea to also use Strings.tbl to change the "Defaults" text to for example "Cycle\nPresets".

The first given block is used as the "global" defaults, used for example when working with the key-pressed SEXP in FRED.

$Name:

FS2 Open, 3.7.4:
  • The name of this control config preset, displayed at the top left corner of the control config screen when selected through the "Defaults" button.
    • Syntax: String


$Bind Name:

  • Name of the bind or action to modify the default key of.
  • Valid entries: List of Bindings
  • Required
  • Syntax: String

$Key Default:

  • Key to set as default
  • Valid entries: Allowed Keys
  • Optional
  • Syntax: String

$Joy Default:

  • Joystick button to set as default
  • Optional
  • Syntax: Integer

$Key Mod Shift:

  • Sets the key to require the Shift key
  • 1 for yes, 0 for no
  • Optional
  • Syntax: Integer

$Key Mod Alt:

  • Sets the key to require the Alt key
  • 1 for yes, 0 for no
  • Optional
  • Syntax: Integer

$Key Mod Ctrl:

  • Sets the key to require the Ctrl key
  • 1 for yes, 0 for no
  • Optional
  • Syntax: Integer

$Category:

  • Tab where the binding appears in the options menu.
  • Valid entries: TARGET_TAB, SHIP_TAB, WEAPON_TAB, COMPUTER_TAB
  • Optional
  • Valid for only the first #ControlConfigOverride block
  • Syntax: String

$Has XStr:

  • Whether or not the binding has an entry in strings.tbl
  • 1 for yes, 0 for no
  • Optional
  • Valid for only the first #ControlConfigOverride block
  • Syntax: Integer

$Type:

Determines the type of control this is.

Valid entries:

  • CC_TYPE_TRIGGER
    • Normal control that activates upon the first press. Resetting devices (such as weapons) will keep firing as long as the key/button is held down.
  • CC_TYPE_CONTINUOUS
    • Control that activates when the key/button is held down, and stays activated until the key/button is released. Ex: Afterburner key.
  • Optional
  • Valid for only the first #ControlConfigOverride block
  • Syntax String

$Disable:

FS2 Open, 3.7.4:
  • Determines whether the binding can be used and appears in the options menu. Can be used to hide bindings which are not needed, or to enable bindings which are hidden by default.
  • Optional
  • Valid for only the first #ControlConfigOverride block
  • Syntax: Boolean


Sample

This example does the following...

  • Sets Clear Escort List to Alt-Shift-Q
  • Sets Target Target's Attacker to Ctrl-Alt-Shift-J, moves it to the Ship Tab, denotes it's type as a trigger and sets it to not have a XString
  • Sets Transfer Energy from Shield to Laser to R
#ControlConfigOverride

$Bind Name:		Clear Escort List
$Key Default:		KEY_Q
$Key Mod Shift:		1
$Key Mod Alt:		1

$Bind Name:		Target Target's Nearest Attacker
$Key Default:		KEY_J
$Key Mod Shift:		1
$Key Mod Alt:		1
$Key Mod Ctrl:		1
$Category:		SHIP_TAB
$Has XStr:		0
$TYPE:			CC_TYPE_TRIGGER

$Bind Name:		Transfer Energy Shield->Laser
$Key Default:		KEY_R

#End

List of Bindings

  • This is a list of all possible bindings that can be modified.
  • Must use the string below (without quotes).
  • These bindings are case-sensitive

Targeting Ships and Objects

  • 'Target Next Ship'
  • 'Target Previous Ship'
  • 'Target Next Closest Hostile Ship'
  • 'Target Previous Closest Hostile Ship'
  • 'Target Next Closest Friendly Ship'
  • 'Target Previous Closest Friendly Ship'
  • 'Target Ship in Reticle'
  • 'Target Target's Nearest Attacker'
  • 'Target Last Ship to Send Transmission'
  • 'Turn Off Targeting'
  • 'Target Closest Attacking Ship'
  • 'Target Next Escort Ship'
  • 'Target Closest Repair Ship'
  • 'Target Next Uninspected Cargo'
  • 'Target Previous Uninspected Cargo'
  • 'Target Newest Ship in Area'
  • 'Target Target's Target'
  • 'Target Next Hostile Bomb or Bomber'
  • 'Target Previous Hostile Bomb or Bomber'

Targeting Subsystems and Turrets

  • 'Target Subsystem in Reticle'
  • 'Target Next Subsystem'
  • 'Target Previous Subsystem'
  • 'Turn Off Targeting of Subsystems'
  • 'Target Next Live Turret'
  • 'Target Previous Live Turret'

Weapons

  • 'Fire Primary Weapon'
  • 'Fire Secondary Weapon'
  • 'Cycle Forward Primary Weapon'
  • 'Cycle Backward Primary Weapon'
  • 'Cycle Secondary Weapon Bank'
  • 'Cycle Secondary Weapon Firing Rate'
  • 'Launch Countermeasure'

Controls

  • 'Forward Thrust'
  • 'Reverse Thrust'
  • 'Bank Left'
  • 'Bank Right'
  • 'Pitch Forward'
  • 'Pitch Backward'
  • 'Turn Left'
  • 'Turn Right'
  • 'Right Thrust'
  • 'Left Thrust'
  • 'Up Thrust'
  • 'Down Thrust'
  • 'Afterburner'
  • 'Glide When Pressed'
  • 'Bank When Pressed'
  • 'Match Target Speed'

Throttle Control

  • 'Set Throttle to Zero'
  • 'Set Throttle to Max'
  • 'Set Throttle to One-Third'
  • 'Set Throttle to Two-Thirds'
  • 'Increase Throttle 5 Percent'
  • 'Decrease Throttle 5 Percent'

HUD Controls

  • 'Toggle High HUD Contrast'
  • 'Toggle HUD'
  • 'Toggle HUD Wireframe Target View'
  • 'Cycle Radar Range'
  • 'Communications Menu'
  • 'Show Nav Map
  • 'Add or Remove Escort'
  • 'Clear Escort List'

Squadmate Messaging

  • 'Attack My Target'
  • 'Disarm My Target'
  • 'Disable My Target'
  • 'Attack My Subsystem'
  • 'Capture My Target'
  • 'Engage Enemy'
  • 'Form on My Wing'
  • 'Ignore My Target'
  • 'Protect My Target'
  • 'Cover Me'
  • 'Return to Base'
  • 'Rearm Me'

Views

  • 'Chase View'
  • 'External View'
  • 'Toggle External Camera Lock'
  • 'Free Look View'
  • 'Current Target View'
  • 'Increase View Distance'
  • 'Decrease View Distance'
  • 'Center View'
  • 'View Up'
  • 'View Rear'
  • 'View Left'
  • 'View Right
  • 'Top-Down View'
  • 'Target Padlock View'

ETS and Shields

  • 'Increase Weapon Energy'
  • 'Decrease Weapon Energy'
  • 'Increase Shield Energy'
  • 'Decrease Shield Energy'
  • 'Increase Engine Energy'
  • 'Decrease Engine Energy'
  • 'Equalize Energy Settings'
  • 'Equalize Shields'
  • 'Augment Forward Shield'
  • 'Augment Rear Shield'
  • 'Augment Left Shield'
  • 'Augment Right Shield'
  • 'Transfer Energy Laser->Shield'
  • 'Transfer Energy Shield->Laser'

Misc

  • 'Enter Subspace (End Mission)'
  • 'Increase Time Compression'
  • 'Decrease Time Compression'
  • 'Toggle Auto Pilot'
  • 'Cycle Nav Points'
  • 'Toggle Gliding'
  • 'Toggle Auto Speed Matching'
  • 'Toggle Auto Targeting'

Multiplayer Only

  • '(Multiplayer) Message All'
  • '(Multiplayer) Message Friendly'
  • '(Multiplayer) Message Hostile'
  • '(Multiplayer) Message Target'
  • '(Multiplayer) Observer Zoom To Target'
  • '(Multiplayer) Toggle Network info'
  • '(Multiplayer) Self Destruct'

Allowed Keys

  • Not all keys are checked by FSO for key bindings, so some of these may not work.
  • List coppied from controlsconfigcommon.cpp and edited to make readable.
  • Must use the string below (without quotes).
  • List of keys
'KEY_0'
'KEY_1'
'KEY_2'
'KEY_3'
'KEY_4'
'KEY_5'
'KEY_6'
'KEY_7'
'KEY_8'
'KEY_9'
'KEY_A'
'KEY_B'
'KEY_C'
'KEY_D'
'KEY_E'
'KEY_F'
'KEY_G'
'KEY_H'
'KEY_I'
'KEY_J'
'KEY_K'
'KEY_L'
'KEY_M'
'KEY_N'
'KEY_O'
'KEY_P'
'KEY_Q'
'KEY_R'
'KEY_S'
'KEY_T'
'KEY_U'
'KEY_V'
'KEY_W'
'KEY_X'
'KEY_Y'
'KEY_Z'
'KEY_MINUS'
'KEY_EQUAL'
'KEY_DIVIDE'
'KEY_SLASH'
'KEY_SLASH_UK'
'KEY_COMMA'
'KEY_PERIOD'
'KEY_SEMICOL'
'KEY_LBRACKET'
'KEY_RBRACKET'
'KEY_RAPOSTRO'
'KEY_LAPOSTRO'
'KEY_ESC'
'KEY_ENTER'
'KEY_BACKSP'
'KEY_TAB'
'KEY_SPACEBAR'
'KEY_NUMLOCK'
'KEY_SCROLLOCK'
'KEY_CAPSLOCK'
'KEY_LSHIFT'
'KEY_RSHIFT'
'KEY_LALT'
'KEY_RALT'
'KEY_LCTRL'
'KEY_RCTRL'
'KEY_F1'
'KEY_F2'
'KEY_F3'
'KEY_F4'
'KEY_F5'
'KEY_F6'
'KEY_F7'
'KEY_F8'
'KEY_F9'
'KEY_F10'
'KEY_F11'
'KEY_F12'
'KEY_PAD0'
'KEY_PAD1'
'KEY_PAD2'
'KEY_PAD3'
'KEY_PAD4'
'KEY_PAD5'
'KEY_PAD6'
'KEY_PAD7'
'KEY_PAD8'
'KEY_PAD9'
'KEY_PADMINUS'
'KEY_PADPLUS'
'KEY_PADPERIOD'
'KEY_PADDIVIDE'
'KEY_PADMULTIPLY'
'KEY_PADENTER'
'KEY_INSERT'
'KEY_HOME'
'KEY_PAGEUP'
'KEY_DELETE'
'KEY_END'
'KEY_PAGEDOWN'
'KEY_UP'
'KEY_DOWN'
'KEY_LEFT'
'KEY_RIGHT'
'KEY_PRINT_SCRN'
'KEY_PAUSE'
'KEY_BREAK'