Difference between revisions of "Autopilot.tbl"

From FreeSpace Wiki
Jump to: navigation, search
m (updated version info)
m
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{SCP_table}}
 
{{SCP_table}}
  
{{TableVersion|5211|5264}}
+
{{TableVersion|5264}}
  
 +
The '''autopilot.tbl''' is used to define the autopilot behavior for a mod. This table is not found in the retail game.
  
'''Autopilot.tbl''' is used to define the autopilot behavior for a mod. This table is not found in the retail game.
+
 
 +
[[Tables|List of Tables]]
  
 
==General Structure==
 
==General Structure==
Line 21: Line 23:
 
*Syntax: '''''Integer'''''}}
 
*Syntax: '''''Integer'''''}}
  
 +
===$Interrupt autopilot if enemy within distance:===
 +
{{Table3612|
 +
*Defines the minimum distance that an enemy has to be from the player at autopilot start and the minimum distance that enemies have to be from the autopilot flight leader in meters.  '''Default is 5000 meters'''.
 +
*Syntax: '''''Integer'''''}}
 +
 +
===$Interrupt autopilot if asteroid within distance:===
 +
{{Table3612|
 +
*Defines the minimum distance that an asteroid has to be from the player for the autopilot to engage and is the minimum distance that an asteroid has to be from the autopilot flight leader in meters.  '''Default is 1000 meters'''.
 +
*Syntax: '''''Integer'''''}}
 +
 +
===$Lock weapons during autopilot:===
 +
{{Table3612|
 +
*Disables all weapons of all ships involved in the cinematic autopilot sequence. '''Default is NO'''.
 +
*Syntax: '''''Boolean'''''}}
  
 
===+No_Cutscene_Bars===
 
===+No_Cutscene_Bars===
Line 36: Line 52:
 
*Allowed events:
 
*Allowed events:
 
::'''$No Nav Selected:'''
 
::'''$No Nav Selected:'''
::*Triggered if no navpoint has been selected when autopilot is activated
+
::*Triggered if no navpoint has been selected when autopilot is activated.
 
::'''$Gliding:'''
 
::'''$Gliding:'''
::*Triggered if autopilot is activated while in glide mode
+
::*Triggered if autopilot is activated while in glide mode.
 
::'''$Too Close:'''
 
::'''$Too Close:'''
::*Triggered if selected navpoint is too close when autopilot is activated
+
::*Triggered if selected navpoint is too close when autopilot is activated.
 
::'''$Hostiles:'''
 
::'''$Hostiles:'''
::*Triggered if hostiles are present when autopilot is activated
+
::*Triggered if hostiles are within 5000 meters when autopilot is activated.
 +
{{Table3612|
 +
::*Triggered when the player is within '''$Interrupt autopilot if enemy within distance:''' meters of an enemy.}}
 
::'''$Linked:'''
 
::'''$Linked:'''
::*Triggered if autopilot is activated when link is active
+
::*Triggered when the player links his autopilot to another ship by flying within '''$Link Distance:'''. See NAV_NEEDS_LINK.
 
::'''$Hazard:'''
 
::'''$Hazard:'''
::*?
+
::*Triggered if the autopilot is activated when too close to a hazard (namely an asteroid)
 +
{{Table3612|
 +
::*Triggered when the player is within '''$Interrupt autopilot if enemy within distance:''' meters of an asteroid.}}
 +
{{Table3612|
 +
::'''$Support Present:'''
 +
::*Triggered when any friendly support ship within range but engine is unable to dismiss the support ship for an unknown reason.
 +
::'''$Support Working:'''
 +
::*Triggered when any friendly support ship within range has an outstanding repair/rearm order.
 +
}}
 
*For each defined event both message and sound file has to be set
 
*For each defined event both message and sound file has to be set
 
*'''+Msg:'''
 
*'''+Msg:'''

Revision as of 04:55, 19 July 2012

This feature requires FreeSpace Open

Revision information.....

FSO Revision: 5264
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 autopilot.tbl is used to define the autopilot behavior for a mod. This table is not found in the retail game.


List of Tables

General Structure

  • Table consists of autopilot section
  • Starts with #Autopilot
  • Ends with #END

Table Contents

FS2 Open 3.6.10:
  • Table works only with new builds


$Link Distance:

FS2 Open 3.6.10:
  • Defines the maximum distance for autopilot link
  • Syntax: Integer

$Interrupt autopilot if enemy within distance:

FS2 Open, 3.6.12:
  • Defines the minimum distance that an enemy has to be from the player at autopilot start and the minimum distance that enemies have to be from the autopilot flight leader in meters. Default is 5000 meters.
  • Syntax: Integer

$Interrupt autopilot if asteroid within distance:

FS2 Open, 3.6.12:
  • Defines the minimum distance that an asteroid has to be from the player for the autopilot to engage and is the minimum distance that an asteroid has to be from the autopilot flight leader in meters. Default is 1000 meters.
  • Syntax: Integer

$Lock weapons during autopilot:

FS2 Open, 3.6.12:
  • Disables all weapons of all ships involved in the cinematic autopilot sequence. Default is NO.
  • Syntax: Boolean

+No_Cutscene_Bars

FS2 Open 3.6.10:
  • Turns the cutscene bars off for the autopilot duration


+No_Autopilot_Interrupt

FS2 Open 3.6.10:
  • Forces autopilot to ignore interrupts

Events

FS2 Open 3.6.10:
  • Table allows for setting both message and sound file for certain events
  • Allowed events:
$No Nav Selected:
  • Triggered if no navpoint has been selected when autopilot is activated.
$Gliding:
  • Triggered if autopilot is activated while in glide mode.
$Too Close:
  • Triggered if selected navpoint is too close when autopilot is activated.
$Hostiles:
  • Triggered if hostiles are within 5000 meters when autopilot is activated.
FS2 Open, 3.6.12:
  • Triggered when the player is within $Interrupt autopilot if enemy within distance: meters of an enemy.
$Linked:
  • Triggered when the player links his autopilot to another ship by flying within $Link Distance:. See NAV_NEEDS_LINK.
$Hazard:
  • Triggered if the autopilot is activated when too close to a hazard (namely an asteroid)
FS2 Open, 3.6.12:
  • Triggered when the player is within $Interrupt autopilot if enemy within distance: meters of an asteroid.
FS2 Open, 3.6.12:
$Support Present:
  • Triggered when any friendly support ship within range but engine is unable to dismiss the support ship for an unknown reason.
$Support Working:
  • Triggered when any friendly support ship within range has an outstanding repair/rearm order.
  • For each defined event both message and sound file has to be set
  • +Msg:
    • Defines the message displayed on screen
    • Syntax: String
  • +Snd File:
    • Defines the sound played
    • Syntax: String, has to include file extension


Example

#Autopilot

$Link Distance: 100

$No Nav Selected:
   +Msg: none
   +Snd File: none.wav

#END