FreeSpace Wiki - User contributions [en]

Model Point Shields

2015-12-07T09:06:29Z

Zookeeper: Added note about mini shield icon incompatibility

{{Table371|}}

==Model Point Shields==
Model point shields are an FSO feature intended to enable ships to have an arbitrary number of shield segments instead of being limited to the standard 4 quadrants. You can have 1, 2, 3, 4, 5 or however many segments your ship needs.

The basic idea is simple: each shield segment is defined by a single point. When something hits the ship, the segment which's point is closest to the point of impact is considered to have gotten hit. By carefully positioning the points in relation to each other and the ship's hull, one can make each segment cover specific parts of the ship.

To use them on a given ship, several things are required:

===Shield points placed in the model file===
Firstly, the number and placement of the shield segments is defined in the model file. In PCS2, you must add each segment as a special point and give it the [[Subobject_and_subsystem_properties#.22shieldpoint.22|$special=shieldpoint]] property. The name and radius of the special point are not used, but a name such as $ShieldsLeft is obviously good to supply for clarity, and the radius can be used as a means to visualize the reach of segments in relation to each other. However, the ordering of the points is meaningful, as it is the only information used by the engine to identify segments, and thus the following steps will need to define things in the exact same order.

===Shield points enabled in ships.tbl===
To enable the ship to use the aforementioned model-defined segments, it needs the [[Ships.tbl#.22model_point_shields.22|"model point shields" ship type flag]].

===Re-mapping of augmentation controls for player ships===
If the player can get to fly the ship, it needs to define which of the standard top/right/rear/left shield augmentation keys applies to which segment, see [[Ships.tbl#.24Model_Point_Shield_Controls:|$Model_Point_Shield_Controls:]]; otherwise, shield augmentation controls will not work at all. Note how the same ordering as in the first step needs to be used here.

===Shield icon===
Shield icons used with standard 4-quadrant shields have their frames ordered as top,right,rear,left. However, here you need to naturally supply the same number of frames as the ship has shield segments, and again, the order of the frames needs to be the same as the order of the segments in the model file.

'''Note:''' the small target hull/shield integrity indicator below the crosshairs is designed to only work with standard 4-quadrant shields and cannot currently be customized per-ship. Therefore mods making use of the feature may want to disable the gauge entirely or override targhit1.ani with an empty one (so that the shield display is disabled, but the hull integrity is still shown).

[[Category:Modding]]

Ships.tbl

2015-08-27T09:18:26Z

Zookeeper: Documented $Collision LOD

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Controlconfigdefaults.tbl

2015-08-27T08:22:58Z

Zookeeper: Documented $Disable

{{TableVersion|7478}}

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

[[Tables|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.
{{Table371|
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:===
{{Table373|
*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: [[Controlconfigdefaults.tbl#List of Bindings|List of Bindings]]
*Required
*Syntax: '''String'''

===$Key Default:===
*Key to set as default
*Valid entries: [[Controlconfigdefaults.tbl#Allowed Keys|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
*Syntax: '''String'''

===$Has XStr:===
*Whether or not the binding has an entry in [[strings.tbl]]
*'''1''' for yes, '''0''' for no
*Optional
*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
*Syntax '''String'''

===$Disable:===
{{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.
**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

<pre>
#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
</pre>

==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'

[[Category:Tables]]

Ships.tbl

2015-07-28T10:37:00Z

Zookeeper: Documented +Minimum Weapon Span

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Subobject and subsystem properties

2015-06-28T11:26:32Z

Zookeeper: Documented $box_offset

This page documents the properties that can be applied to subobjects and to subsystems in their respective properties data in the [[Model files|model file]].

==Important notes==
* Subobject/subsystem properties data is not parsed in order.
* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
* Buffer size of 256 is reserved for the characters in properties data.

==Subsystem Properties==
* These can be applied to subsystems both with and without separate subobject.
{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''Key strings and their order for setting subsystems'''''
|-
| align="center"| ''engine''
| Engine subsystem
|-
| align="center"| ''radar''
| Radar dish subsystem
|-
| align="center"| ''turret''
| Turret subsystem
|-
| align="center"| ''navigation''
| Navigation subsystem
|-
| align="center"| ''communication''
| Communication subsystem
|-
| align="center"| ''weapon''
| Weapon control subsystem
|-
| align="center"| ''sensor''
| Sensor subsystem
|-
| align="center"| ''solar''
| Solar panel subsystem
|-
| align="center"| ''gas''
| Gas collector subsystem
|-
| align="center"| ''activator''
| '''''unused'''''
|-
|}

===$name===
*Defines the alternate name for the subsystem (''string'')
*Alternate subsystem names offer an alternative option for setting this via [[ships.tbl]] file or via mission data.

===$fov===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Defines the firing arc of the turret in degrees (''integer'')
*Defaults to 180 degrees if omitted.

===$crewspot===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Marks the turret as 'crewspot'
*Defines the name of the crewspot (''string'')
*No actual function

===$triggered:===
*Defines the subsystem as a rotating subsystem which can be triggered (animated) via [[Animation Code]]

===$rotate===
*Marks the subsystem as a rotating subsystem
*Defines the rotation time for the subsystem (''float'')

====$pbank====
*Marks the rotation as primary weapon rotation
*Defines the associated weapon bank (''integer'')


====$stepped====
*Defines the rotation as an stepped instead of continuous rotation

=====$steps=====
*Defines the number of steps in the animation (''integer'')
*Defaults to 8

=====$t_paused=====
*Defines the pause time between steps (''float'')
*Defaults to 2

=====$t_transit=====
*Defines the movement time between pauses (''float'')
*Defaults to 2

=====$fraction_accel=====
*Defines the fraction of the stepped rotation time used for acceleration (''float'')
*Is between 0 .. 0.5
*Defaults to 0.3

==Subobject Properties==
* These can be applied only to subsystem with their own separate subobject.

===$dumb_rotate:===
* Marks the subobject as 'dumb rotating object'
* Defines the rotation time (''float'')

===$special===
* Defines special attributes for the subobject
* String, either '''"subsystem"''', '''"no_rotate"''' or '''"shieldpoint"'''

===="subsystem"====
* '''subsystem''' marks the subobject as an subsystem

===="no_rotate"====
* Valid option if '''subsystem''' string was not used
* Marks subobject as an object that should not rotate

===="shieldpoint"====
{{Table371|
* Only usable on special points ('''not''' on submodels).
* Marks the special point as a shield point, see [[Model Point Shields]].}}

===$no_collisions===
* Prevents collision detection from occurring on this subobject and all of its children (recursively).

===$nocollide_this_only===
* Prevents collision detection from occurring on this subobject only (children collide normally).

===$collide_invisible===
* Allows full collision detection for things painted with the special "invisible" texture (normally ships collide but weapons do not)

===$gun_rotation:===
* Marks the submodel as using gun rotation

===[[Detail box|$detail_box:]]===
* Marks the subsystem as one with detail box
====[[Detail box|$box_min:]]====
====[[Detail box|$box_max:]]====
====$box_offset:====
{{Table373|
* Optional offset of the detail box from the model center. Without this, the detail box is centered on the submodel.
* Example: '''$offset: 0,0,-100.5''' to make the detail box be positioned 100.5m behind the ship's center.}}

===$detail_sphere:===
{{Table3615|
* Marks the subsystem as one with detail sphere. Detail spheres work exactly like detail boxes (see above), except that they only define a radius instead of a box.}}
====$radius:====
{{Table3615|
* Defines the radius of the detail sphere (''float''). If not provided, defaults to the submodel radius.}}
====$offset:====
{{Table3615|
* Optional offset of the detail sphere from the model center. Without this, the detail sphere is centered on the submodel.
* Example: '''$offset: 0,0,-100.5''' to make the detail sphere be positioned 100.5m behind the ship's center.}}

===$uvec:===
* Defines the "up" direction (vector) of a multipart turret. Usually it stands perpendicular to the ship surface. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''
* Forces turret normal into the same as the '''$uvec:'''.

===$fvec:===
* Defines the direction of the front a multipart turret will be facing. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''

===$lod0_name===
* Allows adding LODs to older models and changing from special points to modeled subsystems.
* Example $lod0_name=enginea used on a subobject named engine would allow engineb, engienc, and engined to be used while preserving backward compatibility.

===$attach_thrusters===
{{Table3615|
* Allows thrusters associated with this submodel to follow its rotations.}}

[[Category:Modding]]

Ships.tbl

2015-06-12T13:01:44Z

Zookeeper: Documented $Max Shield Recharge

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Weapons.tbl

2015-06-05T11:36:36Z

Zookeeper: Capitalization fix

{{TableVersionGit|2015-05-26|258662ff4c}}

The '''weapons.tbl''' defines all of the weapon classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-wep.tbm

[[Tables|List of Tables]]

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model.
*Syntax: '''''Float'''''
*Default value: 10}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after travelling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Homing:===
'''This option is exclusive to secondaries.'''

Defines if the bolts/missiles in question is homing
*The bolts of primaries will turn to face their target if this option is set to YES... but is otherwise the same as a normal bolt ( when the option is set to NO ).

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how well the missile maneuvers. Is defined as the number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150
***Max: 0.5 (Resets to default if set over 0.5)}}

===$Acceleration Time::===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit::===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be travelling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO currently parses but doesn't use the value, and prints a warning in the log saying that the value will not be used.}}
}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$TrackingSnd===
{{Table3615|
*The looping sound played when this weapon tracks a target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when this weapon has locked onto its target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played when the missile is currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters, default 1.0

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the shield impact explosion, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Dinky Impact Explosion:===
{{Table3610|
*Same as Impact Explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky Impact Explosion Radius:===
{{Table3610|
*Same as Impact Explosion Radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$EMP Intensity:===
*If it has an EMP effect, how deeply it scrambles your electronics
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
}}
{{Table371|
*'''+Area Of Effect'''
**If specified, allows the electronics effect to apply to every ship hit by this weapon's blast or shockwave (the "Electronics" flag isn't necessary with this option).
}}
{{Table3610|
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300.0
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:'''.
}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targeting beam that is used to trigger SSMs. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only needed when editing beams that already exist in other tables.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.
'''Do not use this with MVPs or retail ships unless you increase their density to 10 or use either $Recoil Modifier: in weapons.tbl or $Ship Recoil Modifier in ships.tbl. This is to avoid exaggerated effects due to retail models having manually defined masses.'''}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Weapons.tbl

2015-06-05T11:35:00Z

Zookeeper: Added link from $Shield Impact Explosion Radius to $Shield Impact Explosion

{{TableVersionGit|2015-05-26|258662ff4c}}

The '''weapons.tbl''' defines all of the weapon classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-wep.tbm

[[Tables|List of Tables]]

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model.
*Syntax: '''''Float'''''
*Default value: 10}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after travelling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Homing:===
'''This option is exclusive to secondaries.'''

Defines if the bolts/missiles in question is homing
*The bolts of primaries will turn to face their target if this option is set to YES... but is otherwise the same as a normal bolt ( when the option is set to NO ).

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how well the missile maneuvers. Is defined as the number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150
***Max: 0.5 (Resets to default if set over 0.5)}}

===$Acceleration Time::===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit::===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be travelling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO currently parses but doesn't use the value, and prints a warning in the log saying that the value will not be used.}}
}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$TrackingSnd===
{{Table3615|
*The looping sound played when this weapon tracks a target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when this weapon has locked onto its target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played when the missile is currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters, default 1.0

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the shield impact explosion, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Dinky impact explosion:===
{{Table3610|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky impact explosion radius:===
{{Table3610|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$EMP Intensity:===
*If it has an EMP effect, how deeply it scrambles your electronics
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
}}
{{Table371|
*'''+Area Of Effect'''
**If specified, allows the electronics effect to apply to every ship hit by this weapon's blast or shockwave (the "Electronics" flag isn't necessary with this option).
}}
{{Table3610|
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300.0
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:'''.
}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targeting beam that is used to trigger SSMs. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only needed when editing beams that already exist in other tables.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.
'''Do not use this with MVPs or retail ships unless you increase their density to 10 or use either $Recoil Modifier: in weapons.tbl or $Ship Recoil Modifier in ships.tbl. This is to avoid exaggerated effects due to retail models having manually defined masses.'''}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Ships.tbl

2015-06-05T11:33:21Z

Zookeeper: Documented $Shield Impact Explosion

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Weapons.tbl

2015-06-05T11:30:59Z

Zookeeper: Documented $Shield Impact Explosion Radius

{{TableVersionGit|2015-05-26|258662ff4c}}

The '''weapons.tbl''' defines all of the weapon classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-wep.tbm

[[Tables|List of Tables]]

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model.
*Syntax: '''''Float'''''
*Default value: 10}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after travelling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Homing:===
'''This option is exclusive to secondaries.'''

Defines if the bolts/missiles in question is homing
*The bolts of primaries will turn to face their target if this option is set to YES... but is otherwise the same as a normal bolt ( when the option is set to NO ).

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how well the missile maneuvers. Is defined as the number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150
***Max: 0.5 (Resets to default if set over 0.5)}}

===$Acceleration Time::===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit::===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be travelling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO currently parses but doesn't use the value, and prints a warning in the log saying that the value will not be used.}}
}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$TrackingSnd===
{{Table3615|
*The looping sound played when this weapon tracks a target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when this weapon has locked onto its target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played when the missile is currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters, default 1.0

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the shield impact explosion.
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Dinky impact explosion:===
{{Table3610|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky impact explosion radius:===
{{Table3610|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$EMP Intensity:===
*If it has an EMP effect, how deeply it scrambles your electronics
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
}}
{{Table371|
*'''+Area Of Effect'''
**If specified, allows the electronics effect to apply to every ship hit by this weapon's blast or shockwave (the "Electronics" flag isn't necessary with this option).
}}
{{Table3610|
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1.0
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300.0
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:'''.
}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targeting beam that is used to trigger SSMs. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only needed when editing beams that already exist in other tables.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.
'''Do not use this with MVPs or retail ships unless you increase their density to 10 or use either $Recoil Modifier: in weapons.tbl or $Ship Recoil Modifier in ships.tbl. This is to avoid exaggerated effects due to retail models having manually defined masses.'''}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Ships.tbl

2015-05-27T11:29:00Z

Zookeeper: Documented $Model Icon Direction

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2015-05-27T11:14:54Z

Zookeeper: Documented $Thruster Glow Noise Mult

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2015-05-22T20:19:59Z

Zookeeper: Documented $Minimum Engine Volume

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ai profiles.tbl

2015-05-15T12:02:42Z

Zookeeper: Added links to path metadata bay speed multipliers

{{SCP_table}}

{{TableVersion|9412}}

The '''ai_profiles.tbl''' allows the creation and management of different patterns of AI behavior, called profiles. Profiles consist of various statistics and flags that provide some control over AI behavior. All options within a profile are optional; if an option is not specified it will follow the original FreeSpace 2 retail behavior. Different missions can specify different profiles.

There is a "hidden" profile called FS2 RETAIL that is hard-coded into FreeSpace Open and cannot be modified. It is always the default profile unless another is specified using $Default Profile.

This table is one of the [[Modular Tables]] and can be extended with xxx-aip.tbm

[[Tables|List of Tables]]

==General Format==
'''#AI Profiles'''

'''$Default Profile:''' ''a profile name''

''Up to 9 different AI profiles''

'''#End'''

==#AI Profiles==
*Indicates to the parser that this is an ai_profiles table file.

===$Default Profile:===
*Defines the profile that each mission will use if no profile is specified in FRED. In addition, this profile will be selected automatically in FRED when you create a new mission. If this line is not specified, the default profile will be the FreeSpace 2 retail behavior.

===$Profile Name:===
*The name of the profile, naturally.

----

The following entries accept '''float list''' of five comma-separated values. One value for each of the difficulty levels (Very Easy, Easy, Medium, Hard, Insane).

===$Player Afterburner Recharge Scale:===
{{Table3610|
*Sets the speed of afterburner recharge
*Syntax: '''Float list'''
**Default: 5, 3, 2, 1.5, 1}}

===$Max Beam Friendly Fire Damage:===
{{Table3610|
*Defines the maximum damage inflicted by friendly beam fire
*Syntax: '''Float list'''
**Default: 0, 5, 10, 20, 30}}

===$Player Countermeasure Life Scale:===
{{Table3610|
*Sets the factor applied to player launched countermeasure lifetime
*Syntax: '''Float list'''
**Default: 3, 2, 1.5, 1.25, 1}}

===$AI Countermeasure Firing Chance:===
{{Table3610|
*Defines the chance a countermeasure will be fired by an AI-controlled ship (this is scaled by ai_class)
*Syntax: '''Float list'''
**Default: 0.2, 0.3, 0.5, 0.9, 1.1}}

===$AI In Range Time:===
{{Table3610|
*The delay (in seconds) for the AI to fire its weapons after getting in range.
*Syntax: '''Float list'''
**Default: 2, 1.4, 0.75, 0, -1}}

===$AI Always Links Ammo Weapons:===
{{Table3610|
*AI ships will link ballistic primaries if ammo levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 95, 80, 60, 40, 20}}

===$AI Maybe Links Ammo Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Ammo Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Primary Ammo Burst Multiplier:===
{{Table3611|
*Allows the AI to fire primary weapons in bursts. How long the bursts are (and how much time between them) is a function of ammo remaining, distance to target, angle to target, and this multiplier. A value of 0 turns this feature off (AI fires normally, without bursts). A value < 1 will make for shorter bursts with larger gaps, and a value > 1 will give longer bursts with shorter gaps.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$AI Always Links Energy Weapons:===
{{Table3610|
*AI ships will link energy primaries if energy levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 100, 80, 60, 40, 20}}

===$AI Maybe Links Energy Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Energy Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Max Missiles Locked on Player:===
{{Table3610|
*Defines the maximum number of missiles allowed to be homing in on a player at any given time
*Note: Single-player only, no restriction in multiplayer
*Syntax: '''Float list'''
**Default: 2, 3, 4, 7, 99}}

===$Max Player Attackers:===
{{Table3610|
*Sets the maximum number of ships allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 2, 3, 4, 5, 99}}

===$Max Incoming Asteroids:===
{{Table3610|
*Sets the maximum number of active (i.e. "thrown") asteroids that can be heading toward a friendly ship at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 5, 7, 10}}

===$Player Damage Factor: or $AI Damage Reduction to Player Hull:===
{{Table3610|
*Defines the factor applied to damage suffered by the player
*Syntax: '''Float list'''
**Default: 0.25, 0.5, 0.65, 0.85, 1}}

===$Player Subsys Damage Factor: or $AI Damage Reduction to Player Subsys:===
{{Table3610|
*Sets the factor applied to subsystem damage suffered by the player. This is in addition to the '''$Player Damage Factor:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$Predict Position Delay:===
{{Table3610|
*Sets the measure of time (in F1_0 units) after which the AI will recalculate the position of its target.
*It does not apply to the AI's aim, it only applies to things like avoiding collisions and maneuvering at close range. Generally, anything other than a 0 just allows the AI to do monumentally stupid things like try to turn to avoid ramming where it thought you were 2 seconds ago.
*Syntax: '''Float list'''
**Default: 2, 1.5, 1.333, 0.5, 0}}

===$AI Shield Manage Delay:===
{{Table3610|
*Also '''$AI Shield Manage Delays:'''
*Sets the time in seconds between each instance of an AI ship managing its shields
*Syntax: '''Float list'''
**Default: 5, 4, 2.5, 1.2, 0.1}}

===$Friendly AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 2, 1.4, 1.25, 1.1, 1}}

===$Hostile AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 4, 2.5, 1.75, 1.25, 1}}

===$Friendly AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 0.4, 0.6, 0.8, 1.0, 1.2}}

===$Hostile AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 1.4, 1.2, 1.0, 0.8, 0.6}}

===$AI Turn Time Scale:===
{{Table3610|
*Defines the factor applied to time it takes for enemy ships to turn. A value of 1.0 means the ship turns at normal speed, 2.0 means half speed (takes twice as long), etc. Note that this value ONLY affects ships hostile to the player (always 1.0 for friendly ships).
*Syntax: '''Float list'''
**Default: 3, 2.2, 1.6, 1.3, 1}}

===$Glide Attack Percent:===
{{Table3611|
*How often the AI will use the "glide attack" move when it has the opportunity. Glide attack means using glide to maintain course while aiming and firing at the current target. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Circle Strafe Percent:===
{{Table3611|
*How often the AI will use the "circle strafe" move when it has the opportunity. Circle strafe means that the ship will attempt "Descent-like" combat, trying to maintain distance while circling around the target using sidethrusters. Ships will only attempt this when sidethrust top speed is at least 2/3 of target's current velocity.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Glide Strafe Percent:===
{{Table3611|
*How often the AI will use the "glide strafe" move when it has the opportunity. Glide strafe means using glide to attack capships by flying past and shooting at them. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Random Sidethrust Percent:===
{{Table3611|
*Percentage of the time where AI ships will randomly sidethrust in a dogfight.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Time Threshold:===
{{Table3611|
*The minimum amount of time required for the AI to detect a "stalemate" situation. If a ship and its target have been within a certain distance of each other (defined by ''$Stalemate Distance Threshold'') for this amount of time without either of them scoring a hit on the other, the AI will do something to break the stalemate. Only applies to small ships. If this value is 0 or less, no stalemate detection is performed.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Distance Threshold:===
{{Table3611|
*The maximum distance that an AI ship must remain from its target for a "stalemate" to occur (see ''$Stalemate Time Threshold'').
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Shield Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's shields recharge
*Syntax: '''Float list'''
**Default: 4, 2, 1.5, 1.25, 1}}

===$Player Weapon Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's weapons recharge
*Syntax: '''Float list'''
**Default: 10, 4, 2.5, 2, 1.5}}

===$Max Turret Target Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the same target at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Max Turret Player Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Percentage Required For Kill Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.30, 0.30, 0.30, 0.30, 0.30}}

===$Percentage Required For Assist Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded an assist (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.15, 0.15, 0.15, 0.15, 0.15}}

===$Percentage Awarded For Capship Assist:===
{{Table3610|
*In TvT and Coop missions all teammates will be granted this percentage of the capships score when someone scores a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.5, 0.5, 0.5, 0.5, 0.5}}

===$Repair Penalty:===
{{Table3611|
*The amount to subtract from the player's score if they are repaired by a support ship
*Syntax: '''Integer list'''
**Default: 10, 20, 35, 50, 60}}

===$Delay Before Allowing Bombs to Be Shot Down:===
{{Table3611|
*Time after bombs are fired during which the bombs are invulnerable to weapon hits
*Syntax: '''Float list'''
**Default: 1.5, 1.5, 1.5, 1.5, 1.5}}

===$Chance AI Has to Fire Missiles at Player:===
{{Table3611|
*Chance - expressed in ('''value''' + 1) / 7 - of each AI turret within current 10 second segment to be allowed to shoot missiles at player ship.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4}}

===$Max Aim Update Delay:===
{{Table3611|
*Maximum amount of delay allowed before the AI will update its aim. Until the next update, the AI will project the target forward based on last checked position and velocity. Applies to small ships vs small ships (dogfights). The actual delay is randomly selected between 0 and the maximum (so setting a value of 2 will result in an average of 1 second delay).
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Turret Max Aim Update Delay:===
{{Table3611|
*As $Max Aim Update Delay, but affecting turrets instead
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Autoaim FOV:===
{{Table3613|
*Gives the player autoaim within the specified number of degrees from the target (FOV).
*Unlike the ships.tbl settings for autoaim, this only affects the player (and, of course, only if there is a nonzero value for the difficulty level.)
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Detail Distance Multiplier:===
{{Table3613|
*Affects how the "model detail level" setting in Options switches between LOD levels.
*This number acts as a multiplier on the LOD distances specified in ships.tbl.
*NOTE THAT THIS IS PER DETAIL LEVEL, NOT PER DIFFICULTY LEVEL.
*Syntax: '''Float list'''
**Default: 0.125, 0.25, 1.0, 4.0, 8.0}}
----

The following entries are boolean flags. They can be set to ''YES'' or ''NO'', ''TRUE'' or ''FALSE'', ''OUI'' or ''NON'', ''HIja′'' or ''ghobe′'', etc. The default is ''NO''.

===$big ships can attack beam turrets on untargeted ships:===
{{Table3610|
*If set, big ships can attack a beam turret that's firing on them from a ship that they don't currently have targeted.}}

===$smart primary weapon selection:===
{{Table3610|
*If set, enables the new primary weapon selection method}}

===$smart secondary weapon selection:===
{{Table3610|
*If set, enables the new secondary weapon selection method (including proper use of bomber+ missiles)}}

===$smart shield management:===
{{Table3610|
*If set, shields will devote all their charging energy to the weakest quadrant(s) and not waste energy on fully-charged quadrants (previously was -smart_shields on the command line)}}

===$smart afterburner management:===
{{Table3610|
*If set, the AI will properly use brief pulses of afterburner power instead of afterburning until fuel is exhausted}}

===$allow rapid secondary dumbfire:===
{{Table3610|
*If set, allows an AI ship to switch to rapid fire for dumbfire missiles}}

===$huge turret weapons ignore bombs:===
{{Table3610|
*If set, causes huge turret weapons (including anti-capship beams) to not target bombs}}

===$don't insert random turret fire delay:===
{{Table3610|
*If set, removes the random turret fire delay (from .1 to .9 seconds) inserted in addition to AI Fire Delay Scale}}

===$hack improve non-homing swarm turret fire accuracy:===
{{Table3610|
*If set, triggers a hack to improves the accuracy of non-homing swarm missiles by firing them along the turret's last fire direction rather than the direction it currently faces
*Also disables swarm weapons ability to fire only on the 'turrets barrel line'.}}

===$shockwaves damage small ship subsystems:===
{{Table3610|
*If set, shockwaves will cause damage to small ship subsystems (like in FS1)}}

===$navigation subsystem governs warpout capability:===
{{Table3610|
*If set, ships will not be able to warp out if their navigation subsystem is destroyed or low in strength}}

===$ignore lower bound for minimum speed of docked ship:===
{{Table3610|
*If set, there will be no lower bound for the speed at which docked ships move (like in FS1).
*When a ship is towing another ship or ships, the towing ship will be slowed down to a degree depending on the total mass of all docked ships. In FS1, the ships could slow down to an arbitrarily slow speed, even a fraction of a m/s above zero. In FS2, there is a lower bound on this behavior so that all ships are guaranteed to move at a minimum docked speed. When set, this flag removes the lower bound and restores FS1 behavior.}}

===$disable linked fire penalty:===
{{Table3610|
*If set, there will be no penalty for linking primaries. Normally, the rate of fire is *1 for a single bank, *0.66 for two banks and *0.5 for three banks (the fire delay is increased according to the formula 1+([nb of banks]-1)*0.5 ).}}

===$disable weapon damage scaling:===
{{Table3610|
*If set, weapons will do the same damage to a ship regardless of "big damage", "supercap", etc. ship types.}}

===$use additive weapon velocity:===
{{Table3610|
*If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly. This also improves the accuracy of weapons fired while gliding.}}

===$use newtonian dampening:===
{{Table3610|
*Newtonian Dampening changes turning and acceleration behavior. By default, there's quite a bit of slide when you turn, and when combined with high damp values (such as in BtRL), you can actually push your speed up beyond the max. Newtonian Dampening is the more realistic turns, where too much turning will lower your speed. Forward momentum is also affected. Backslash can explain it in more detail. [http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741] }}

===$include beams for kills and assists:===
{{Table3610|
*If set, beam damage is counted when calculating kills and assists.}}

===$score kills based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the killer inflicted on the dead ship.}}

===$score assists based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the player gaining the assist inflicted on the dead ship.}}

===$allow event and goal scoring in multiplayer:===
{{Table3610|
*If set, players (rather than just their team) can gain score from events in multiplayer.}}

===$fix linked primary weapon decision bug:===
{{Table3610|
*If set, the AI will properly link primaries according to specified percentages of energy levels instead of retail behavior where it mistakenly linked according to absolute energy levels.}}

===$prevent turrets targeting too distant bombs:===
{{Table3610|
*If set, prevents turrets from targeting bombs beyond maximum range of the weapons of the turret.}}

===$smart subsystem targeting for turrets:===
{{Table3610|
*If set, prevents turrets from trying to target subsystems beyond their fov limits, also keeps the turret subsystem targeting preference order intact regardless of the angle to the target.}}

===$fix heat seekers homing on stealth ships bug:===
{{Table3610|
*If set, heat-seeking missiles will not home in on stealth ships (this mirrors the established behavior where heat-seeking missiles do not home in on ships that are hidden from sensors).}}

===$multi allow empty primaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without primaries.}}

===$multi allow empty secondaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without secondaries.}}

===$allow turrets target weapons freely:===
{{Table3611|
*If set, allows turrets to target any weapons instead of just targeting bombs, to be used in conjunction with target priorities setup.}}

===$use only single fov for turrets:===
{{Table3611|
*If set, allows turrets to fire outside some hardcoded FOV set for certain missile types limits, and rely only on the user defined FOV.}}

===$allow vertical dodge:===
{{Table3611|
*If set, allows ships to dodge weapons fire vertically as well as horizontally.}}

===$force beam turrets to use normal fov:===
{{Table3611|
*If set makes beam turrets use same FOV rules as other weapons do. Prevents beam from a turret from following the target beyond the turret's FOV}}

===$fix AI class bug:===
{{Table3611|
*Fixes a bug where AI class attributes are not set properly on ships if the AI class is set in the mission to something other than the default for the ship type. Set this to YES if you want attributes in [[Ai.tbl]] to mean anything at all.}}

===$turrets ignore targets radius in range checks:===
{{Table3611|
*TBD.}}

===$no extra collision avoidance vs player:===
{{Table3611|
*Disables the extra collision avoidance that AI normally uses against the player. Makes the AI more aggressive vs the player at close range (same treatment as vs other AI), although ship-ship collisions are slightly more likely.}}

===$perform fewer checks for death screams:===
{{Table3614|
*If set, the game will check if the dying ship is a player's wingman, before making it give a death scream.
Prior to revision 9119, this was "$perform fewer checks for death screams:", but the old version will still parse correctly.}}

===$advanced turret fov edge checks:===
{{Table3614|
*TBD.}}

===$require turrets to have target in fov:===
{{Table3614|
*TBD.}}

===$all ships manage shields:===
{{Table3613|
*Allows AI to manage shields on big ships}}

===$ai aims from ship center:===
{{Table3613|
*AI aims weapons using the center of the ship instead of the first gunpoint. If a convergence offset is specified for this ship in ships.tbl, AI aims using that as a reference point.}}

===$allow primary link at mission start:===
{{Table370|
*When set, no ships will link primaries for the first 30 seconds of a mission. In addition, ships will randomly not link for the first two minutes of a mission. Set this to NO to get rid of this often-problematic retail behavior. (Prior to revision 9119, this was called $allow primary link delay and defaulted to YES. The old method is still supported for compatibility.)}}

===$allow beams to damage bombs:===
{{Table3613|
*When set, beam weapons will be able to effectively intercept bombs. In addition, bombs flying through a beam path will get damaged and destroyed. Default: NO.}}

===$disable weapon damage scaling for player:===
{{Table3613|
*When set, Player weapon damage will no longer be scaled down when firing a non-huge primary against a ship with the "big damage" flag. Use with caution, as this may severely impact mission balance.}}

===$countermeasures affect aspect seekers:===
{{Table3613|
*TBD.}}

===$ai guards specific ship in wing:===
{{Table3615|
*If ordered to guard a ship in a wing (of which it is not a member), the AI will guard that specific ship instead of the entire wing (resulting in guarding the wing leader).}}

===$ai path mode:===
{{Table3613|
*Possible options are "normal" and "alt1". The alt1 mode differs from the normal behaviour in the following ways:
**1. No path shortcutting. Normal pathing AI will skip forward along a path to the furthest point it can reach. This is sometimes desirable, but makes it a lot harder to predict how the AI is going to behave at various points along a path. Turning this off also allows us to force the AI to straighten out, by giving it several waypoints in a more-or-less straight line. This is useful for such things as lining up a landing.
**2. No sliding when following paths. Docking still works, but there is some code that causes the AI to go full retard if it just misses a point: it turns towards the point in big, looping circles. This is apparently caused by passing a slide_vec value into ai_turn_towards_vector, which doesn't even seem to do what you'd expect it to do. Passing a null value instead turns off the stupid. (The behavior is fixed in alt1).
**3. Momentum taken into account when following paths. Path points will trigger sooner, proportional to the ship's speed and momentum. This prevents the AI from massively overshooting a waypoint, especially with high-damp ships.
**4. AI tries to follow the line between waypoints. Instead of just pointing at the next waypoint, the AI will fly a bit towards the line. This helps keep the AI actually on the path it claims to be following. See picture:[[Image:Altpaths.png]]
Blue is what happens with regular pathing. Red is the modified pathing: as you can see, it actively moves back towards the line.
**5. AI will respect "cap-waypoint-speed" when following paths (such as when docking or departing via bay).}}

===$default weapon select effect:===
{{Table3613|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$default ship select effect:===
{{Table3613|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$no warp camera:===
{{Table3615|
*When set, prevents the view from switching to the external camera when the player warps out.
*Note: this flag is deprecated and may get moved to another table without further notice.}}

===$fix ai path order bug:===
{{Table3615|
*When set, ship will follow its own waypoint path unless the wingleader has the same waypoint path and order.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$bay arrive speed multiplier:===
{{Table373|
*Causes all AI ships arriving from fighterbays (following a fighterbay path) to gradually accelerate, instead of immediately attempting to attain maximum speed. This can be used to prevent fighters from overshooting the fighterbay paths. The initial target speed is the maximum speed multiplied by the given value, with the multiplier gradually approaching 1.0 as the distance to the end of the path decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers, see [[Ships.tbl#.2Barrive_speed_multiplier:]].}}
}}

===$bay depart speed multiplier:===
{{Table373|
*Same as above, except for departures into fighterbays. The initial target speed is the maximum speed, with the target speed gradually approaching maximum speed multiplied by the given value as the distance to the fighterbay decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers, see [[Ships.tbl#.2Bdepart_speed_multiplier:]].}}
}}

==Sample Entry==
*Retail FS2 behaviour

<pre>
#AI Profiles

$Default Profile: FS2 RETAIL

$Profile Name: FS2 RETAIL

$Player Afterburner Recharge Scale: 5, 3, 2, 1.5, 1
$Max Beam Friendly Fire Damage: 0, 5, 10, 20, 30
$Player Countermeasure Life Scale: 3, 2, 1.5, 1.25, 1
$AI Countermeasure Firing Chance: 0.2, 0.3, 0.5, 0.9, 1.1
$AI In Range Time: 2, 1.4, 0.75, 0, -1
$AI Always Links Ammo Weapons: 95, 80, 60, 40, 20
$AI Maybe Links Ammo Weapons: 90, 60, 40, 20, 10
$Primary Ammo Burst Multiplier: 0, 0, 0, 0, 0
$AI Always Links Energy Weapons: 100, 80, 60, 40, 20
$AI Maybe Links Energy Weapons: 90, 60, 40, 20, 10
$Max Missiles Locked on Player: 2, 3, 4, 7, 99
$Max Player Attackers: 2, 3, 4, 5, 99
$Max Incoming Asteroids: 3, 4, 5, 7, 10
$Player Damage Factor: 0.25, 0.5, 0.65, 0.85, 1
$Player Subsys Damage Factor: 0.2, 0.4, 0.6, 0.8, 1
$Predict Position Delay: 2, 1.5, 1.333,0.5, 0
$AI Shield Manage Delay: 5, 4, 2.5, 1.2, 0.1
$Friendly AI Fire Delay Scale: 2, 1.4, 1.25, 1.1, 1
$Hostile AI Fire Delay Scale: 4, 2.5, 1.75, 1.25, 1
$Friendly AI Secondary Fire Delay Scale: 0.4, 0.6, 0.8, 1.0, 1.2
$Hostile AI Secondary Fire Delay Scale: 1.4, 1.2, 1.0, 0.8, 0.6
$AI Turn Time Scale: 3, 2.2, 1.6, 1.3, 1
$Glide Attack Percent: 0, 0, 0, 0, 0
$Circle Strafe Percent: 0, 0, 0, 0, 0
$Glide Strafe Percent: 0, 0, 0, 0, 0
$Random Sidethrust Percent: 0, 0, 0, 0, 0
$Stalemate Time Threshold: 0, 0, 0, 0, 0
$Stalemate Distance Threshold: 0, 0, 0, 0, 0
$Player Shield Recharge Scale: 4, 2, 1.5, 1.25, 1
$Player Weapon Recharge Scale: 10, 4, 2.5, 2, 1.5
$Max Turret Target Ownage: 3, 4, 7, 12, 19
$Max Turret Player Ownage: 3, 4, 7, 12, 19
$Percentage Required For Kill Scale: 0.30, 0.30, 0.30, 0.30, 0.30
$Percentage Required For Assist Scale: 0.15, 0.15, 0.15, 0.15, 0.15
$Percentage Awarded For Capship Assist: 0.1, 0.2, 0.35, 0.5, 0.6
$Repair Penalty: 10, 20, 35, 50, 60
$Delay Before Allowing Bombs to Be Shot Down: 1.5, 1.5, 1.5, 1.5, 1.5
$Chance AI Has to Fire Missiles at Player: 0, 1, 2, 3, 4
$Max Aim Update Delay: 0, 0, 0, 0, 0
$Turret Max Aim Update Delay: 0, 0, 0, 0, 0
$Player Autoaim FOV: 0, 0, 0, 0, 0
$Detail Distance Multiplier: 0.125,0.25, 1.0, 4.0, 8.0

$big ships can attack beam turrets on untargeted ships: NO
$smart primary weapon selection: NO
$smart secondary weapon selection: NO
$smart shield management: NO
$smart afterburner management: NO
$allow rapid secondary dumbfire: NO
$huge turret weapons ignore bombs: NO
$don't insert random turret fire delay: NO
$hack improve non-homing swarm turret fire accuracy: NO
$shockwaves damage small ship subsystems: NO
$navigation subsystem governs warpout capability: NO
$ignore lower bound for minimum speed of docked ship: NO
$disable linked fire penalty: NO
$disable weapon damage scaling: NO
$use additive weapon velocity: NO
$use newtonian dampening: NO
$include beams for kills and assists: NO
$score kills based on damage caused: NO
$score assists based on damage caused: NO
$allow event and goal scoring in multiplayer: NO
$fix linked primary weapon decision bug: NO
$prevent turrets targeting too distant bombs: NO
$smart subsystem targeting for turrets: NO
$fix heat seekers homing on stealth ships bug: NO
$multi allow empty primaries: NO
$multi allow empty secondaries: NO
$allow turrets target weapons freely: NO
$use only single fov for turrets: NO
$allow vertical dodge: NO
$force beam turrets to use normal fov: NO
$fix AI class bug: NO
$turrets ignore targets radius in range checks: NO
$no extra collision avoidance vs player: NO
$perform fewer checks for death screams: NO
$advanced turret fov edge checks: NO
$require turrets to have target in fov: NO
$all ships manage shields: NO
$ai aims from ship center: NO
$allow primary link at mission start: NO
$allow beams to damage bombs: NO
$disable weapon damage scaling for player: NO
$countermeasures affect aspect seekers: NO
$ai path mode: normal
$no warp camera: NO

#End
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741 Re: New difficulty? - Feature request!]", ''Hard Light Productions Forums'', Hard Light Productions, 2007-12-15. Retrieved on [[December_27]], [[2007]].

[[Category:Tables]]

Ships.tbl

2015-05-15T12:00:10Z

Zookeeper: Fixed wrong nesting level

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2015-05-15T11:53:26Z

Zookeeper: Documented +arrive/depart speed multiplier

{{TableVersionGit|2015-05-12|5dfbc6d292}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
===+arrive speed multiplier:===
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
===+depart speed multiplier:===
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ai profiles.tbl

2015-05-15T11:49:26Z

Zookeeper: Documented $bay arrive/depart speed multiplier

{{SCP_table}}

{{TableVersion|9412}}

The '''ai_profiles.tbl''' allows the creation and management of different patterns of AI behavior, called profiles. Profiles consist of various statistics and flags that provide some control over AI behavior. All options within a profile are optional; if an option is not specified it will follow the original FreeSpace 2 retail behavior. Different missions can specify different profiles.

There is a "hidden" profile called FS2 RETAIL that is hard-coded into FreeSpace Open and cannot be modified. It is always the default profile unless another is specified using $Default Profile.

This table is one of the [[Modular Tables]] and can be extended with xxx-aip.tbm

[[Tables|List of Tables]]

==General Format==
'''#AI Profiles'''

'''$Default Profile:''' ''a profile name''

''Up to 9 different AI profiles''

'''#End'''

==#AI Profiles==
*Indicates to the parser that this is an ai_profiles table file.

===$Default Profile:===
*Defines the profile that each mission will use if no profile is specified in FRED. In addition, this profile will be selected automatically in FRED when you create a new mission. If this line is not specified, the default profile will be the FreeSpace 2 retail behavior.

===$Profile Name:===
*The name of the profile, naturally.

----

The following entries accept '''float list''' of five comma-separated values. One value for each of the difficulty levels (Very Easy, Easy, Medium, Hard, Insane).

===$Player Afterburner Recharge Scale:===
{{Table3610|
*Sets the speed of afterburner recharge
*Syntax: '''Float list'''
**Default: 5, 3, 2, 1.5, 1}}

===$Max Beam Friendly Fire Damage:===
{{Table3610|
*Defines the maximum damage inflicted by friendly beam fire
*Syntax: '''Float list'''
**Default: 0, 5, 10, 20, 30}}

===$Player Countermeasure Life Scale:===
{{Table3610|
*Sets the factor applied to player launched countermeasure lifetime
*Syntax: '''Float list'''
**Default: 3, 2, 1.5, 1.25, 1}}

===$AI Countermeasure Firing Chance:===
{{Table3610|
*Defines the chance a countermeasure will be fired by an AI-controlled ship (this is scaled by ai_class)
*Syntax: '''Float list'''
**Default: 0.2, 0.3, 0.5, 0.9, 1.1}}

===$AI In Range Time:===
{{Table3610|
*The delay (in seconds) for the AI to fire its weapons after getting in range.
*Syntax: '''Float list'''
**Default: 2, 1.4, 0.75, 0, -1}}

===$AI Always Links Ammo Weapons:===
{{Table3610|
*AI ships will link ballistic primaries if ammo levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 95, 80, 60, 40, 20}}

===$AI Maybe Links Ammo Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Ammo Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Primary Ammo Burst Multiplier:===
{{Table3611|
*Allows the AI to fire primary weapons in bursts. How long the bursts are (and how much time between them) is a function of ammo remaining, distance to target, angle to target, and this multiplier. A value of 0 turns this feature off (AI fires normally, without bursts). A value < 1 will make for shorter bursts with larger gaps, and a value > 1 will give longer bursts with shorter gaps.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$AI Always Links Energy Weapons:===
{{Table3610|
*AI ships will link energy primaries if energy levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 100, 80, 60, 40, 20}}

===$AI Maybe Links Energy Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Energy Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Max Missiles Locked on Player:===
{{Table3610|
*Defines the maximum number of missiles allowed to be homing in on a player at any given time
*Note: Single-player only, no restriction in multiplayer
*Syntax: '''Float list'''
**Default: 2, 3, 4, 7, 99}}

===$Max Player Attackers:===
{{Table3610|
*Sets the maximum number of ships allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 2, 3, 4, 5, 99}}

===$Max Incoming Asteroids:===
{{Table3610|
*Sets the maximum number of active (i.e. "thrown") asteroids that can be heading toward a friendly ship at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 5, 7, 10}}

===$Player Damage Factor: or $AI Damage Reduction to Player Hull:===
{{Table3610|
*Defines the factor applied to damage suffered by the player
*Syntax: '''Float list'''
**Default: 0.25, 0.5, 0.65, 0.85, 1}}

===$Player Subsys Damage Factor: or $AI Damage Reduction to Player Subsys:===
{{Table3610|
*Sets the factor applied to subsystem damage suffered by the player. This is in addition to the '''$Player Damage Factor:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$Predict Position Delay:===
{{Table3610|
*Sets the measure of time (in F1_0 units) after which the AI will recalculate the position of its target.
*It does not apply to the AI's aim, it only applies to things like avoiding collisions and maneuvering at close range. Generally, anything other than a 0 just allows the AI to do monumentally stupid things like try to turn to avoid ramming where it thought you were 2 seconds ago.
*Syntax: '''Float list'''
**Default: 2, 1.5, 1.333, 0.5, 0}}

===$AI Shield Manage Delay:===
{{Table3610|
*Also '''$AI Shield Manage Delays:'''
*Sets the time in seconds between each instance of an AI ship managing its shields
*Syntax: '''Float list'''
**Default: 5, 4, 2.5, 1.2, 0.1}}

===$Friendly AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 2, 1.4, 1.25, 1.1, 1}}

===$Hostile AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 4, 2.5, 1.75, 1.25, 1}}

===$Friendly AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 0.4, 0.6, 0.8, 1.0, 1.2}}

===$Hostile AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 1.4, 1.2, 1.0, 0.8, 0.6}}

===$AI Turn Time Scale:===
{{Table3610|
*Defines the factor applied to time it takes for enemy ships to turn. A value of 1.0 means the ship turns at normal speed, 2.0 means half speed (takes twice as long), etc. Note that this value ONLY affects ships hostile to the player (always 1.0 for friendly ships).
*Syntax: '''Float list'''
**Default: 3, 2.2, 1.6, 1.3, 1}}

===$Glide Attack Percent:===
{{Table3611|
*How often the AI will use the "glide attack" move when it has the opportunity. Glide attack means using glide to maintain course while aiming and firing at the current target. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Circle Strafe Percent:===
{{Table3611|
*How often the AI will use the "circle strafe" move when it has the opportunity. Circle strafe means that the ship will attempt "Descent-like" combat, trying to maintain distance while circling around the target using sidethrusters. Ships will only attempt this when sidethrust top speed is at least 2/3 of target's current velocity.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Glide Strafe Percent:===
{{Table3611|
*How often the AI will use the "glide strafe" move when it has the opportunity. Glide strafe means using glide to attack capships by flying past and shooting at them. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Random Sidethrust Percent:===
{{Table3611|
*Percentage of the time where AI ships will randomly sidethrust in a dogfight.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Time Threshold:===
{{Table3611|
*The minimum amount of time required for the AI to detect a "stalemate" situation. If a ship and its target have been within a certain distance of each other (defined by ''$Stalemate Distance Threshold'') for this amount of time without either of them scoring a hit on the other, the AI will do something to break the stalemate. Only applies to small ships. If this value is 0 or less, no stalemate detection is performed.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Distance Threshold:===
{{Table3611|
*The maximum distance that an AI ship must remain from its target for a "stalemate" to occur (see ''$Stalemate Time Threshold'').
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Shield Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's shields recharge
*Syntax: '''Float list'''
**Default: 4, 2, 1.5, 1.25, 1}}

===$Player Weapon Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's weapons recharge
*Syntax: '''Float list'''
**Default: 10, 4, 2.5, 2, 1.5}}

===$Max Turret Target Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the same target at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Max Turret Player Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Percentage Required For Kill Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.30, 0.30, 0.30, 0.30, 0.30}}

===$Percentage Required For Assist Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded an assist (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.15, 0.15, 0.15, 0.15, 0.15}}

===$Percentage Awarded For Capship Assist:===
{{Table3610|
*In TvT and Coop missions all teammates will be granted this percentage of the capships score when someone scores a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.5, 0.5, 0.5, 0.5, 0.5}}

===$Repair Penalty:===
{{Table3611|
*The amount to subtract from the player's score if they are repaired by a support ship
*Syntax: '''Integer list'''
**Default: 10, 20, 35, 50, 60}}

===$Delay Before Allowing Bombs to Be Shot Down:===
{{Table3611|
*Time after bombs are fired during which the bombs are invulnerable to weapon hits
*Syntax: '''Float list'''
**Default: 1.5, 1.5, 1.5, 1.5, 1.5}}

===$Chance AI Has to Fire Missiles at Player:===
{{Table3611|
*Chance - expressed in ('''value''' + 1) / 7 - of each AI turret within current 10 second segment to be allowed to shoot missiles at player ship.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4}}

===$Max Aim Update Delay:===
{{Table3611|
*Maximum amount of delay allowed before the AI will update its aim. Until the next update, the AI will project the target forward based on last checked position and velocity. Applies to small ships vs small ships (dogfights). The actual delay is randomly selected between 0 and the maximum (so setting a value of 2 will result in an average of 1 second delay).
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Turret Max Aim Update Delay:===
{{Table3611|
*As $Max Aim Update Delay, but affecting turrets instead
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Autoaim FOV:===
{{Table3613|
*Gives the player autoaim within the specified number of degrees from the target (FOV).
*Unlike the ships.tbl settings for autoaim, this only affects the player (and, of course, only if there is a nonzero value for the difficulty level.)
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Detail Distance Multiplier:===
{{Table3613|
*Affects how the "model detail level" setting in Options switches between LOD levels.
*This number acts as a multiplier on the LOD distances specified in ships.tbl.
*NOTE THAT THIS IS PER DETAIL LEVEL, NOT PER DIFFICULTY LEVEL.
*Syntax: '''Float list'''
**Default: 0.125, 0.25, 1.0, 4.0, 8.0}}
----

The following entries are boolean flags. They can be set to ''YES'' or ''NO'', ''TRUE'' or ''FALSE'', ''OUI'' or ''NON'', ''HIja′'' or ''ghobe′'', etc. The default is ''NO''.

===$big ships can attack beam turrets on untargeted ships:===
{{Table3610|
*If set, big ships can attack a beam turret that's firing on them from a ship that they don't currently have targeted.}}

===$smart primary weapon selection:===
{{Table3610|
*If set, enables the new primary weapon selection method}}

===$smart secondary weapon selection:===
{{Table3610|
*If set, enables the new secondary weapon selection method (including proper use of bomber+ missiles)}}

===$smart shield management:===
{{Table3610|
*If set, shields will devote all their charging energy to the weakest quadrant(s) and not waste energy on fully-charged quadrants (previously was -smart_shields on the command line)}}

===$smart afterburner management:===
{{Table3610|
*If set, the AI will properly use brief pulses of afterburner power instead of afterburning until fuel is exhausted}}

===$allow rapid secondary dumbfire:===
{{Table3610|
*If set, allows an AI ship to switch to rapid fire for dumbfire missiles}}

===$huge turret weapons ignore bombs:===
{{Table3610|
*If set, causes huge turret weapons (including anti-capship beams) to not target bombs}}

===$don't insert random turret fire delay:===
{{Table3610|
*If set, removes the random turret fire delay (from .1 to .9 seconds) inserted in addition to AI Fire Delay Scale}}

===$hack improve non-homing swarm turret fire accuracy:===
{{Table3610|
*If set, triggers a hack to improves the accuracy of non-homing swarm missiles by firing them along the turret's last fire direction rather than the direction it currently faces
*Also disables swarm weapons ability to fire only on the 'turrets barrel line'.}}

===$shockwaves damage small ship subsystems:===
{{Table3610|
*If set, shockwaves will cause damage to small ship subsystems (like in FS1)}}

===$navigation subsystem governs warpout capability:===
{{Table3610|
*If set, ships will not be able to warp out if their navigation subsystem is destroyed or low in strength}}

===$ignore lower bound for minimum speed of docked ship:===
{{Table3610|
*If set, there will be no lower bound for the speed at which docked ships move (like in FS1).
*When a ship is towing another ship or ships, the towing ship will be slowed down to a degree depending on the total mass of all docked ships. In FS1, the ships could slow down to an arbitrarily slow speed, even a fraction of a m/s above zero. In FS2, there is a lower bound on this behavior so that all ships are guaranteed to move at a minimum docked speed. When set, this flag removes the lower bound and restores FS1 behavior.}}

===$disable linked fire penalty:===
{{Table3610|
*If set, there will be no penalty for linking primaries. Normally, the rate of fire is *1 for a single bank, *0.66 for two banks and *0.5 for three banks (the fire delay is increased according to the formula 1+([nb of banks]-1)*0.5 ).}}

===$disable weapon damage scaling:===
{{Table3610|
*If set, weapons will do the same damage to a ship regardless of "big damage", "supercap", etc. ship types.}}

===$use additive weapon velocity:===
{{Table3610|
*If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly. This also improves the accuracy of weapons fired while gliding.}}

===$use newtonian dampening:===
{{Table3610|
*Newtonian Dampening changes turning and acceleration behavior. By default, there's quite a bit of slide when you turn, and when combined with high damp values (such as in BtRL), you can actually push your speed up beyond the max. Newtonian Dampening is the more realistic turns, where too much turning will lower your speed. Forward momentum is also affected. Backslash can explain it in more detail. [http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741] }}

===$include beams for kills and assists:===
{{Table3610|
*If set, beam damage is counted when calculating kills and assists.}}

===$score kills based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the killer inflicted on the dead ship.}}

===$score assists based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the player gaining the assist inflicted on the dead ship.}}

===$allow event and goal scoring in multiplayer:===
{{Table3610|
*If set, players (rather than just their team) can gain score from events in multiplayer.}}

===$fix linked primary weapon decision bug:===
{{Table3610|
*If set, the AI will properly link primaries according to specified percentages of energy levels instead of retail behavior where it mistakenly linked according to absolute energy levels.}}

===$prevent turrets targeting too distant bombs:===
{{Table3610|
*If set, prevents turrets from targeting bombs beyond maximum range of the weapons of the turret.}}

===$smart subsystem targeting for turrets:===
{{Table3610|
*If set, prevents turrets from trying to target subsystems beyond their fov limits, also keeps the turret subsystem targeting preference order intact regardless of the angle to the target.}}

===$fix heat seekers homing on stealth ships bug:===
{{Table3610|
*If set, heat-seeking missiles will not home in on stealth ships (this mirrors the established behavior where heat-seeking missiles do not home in on ships that are hidden from sensors).}}

===$multi allow empty primaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without primaries.}}

===$multi allow empty secondaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without secondaries.}}

===$allow turrets target weapons freely:===
{{Table3611|
*If set, allows turrets to target any weapons instead of just targeting bombs, to be used in conjunction with target priorities setup.}}

===$use only single fov for turrets:===
{{Table3611|
*If set, allows turrets to fire outside some hardcoded FOV set for certain missile types limits, and rely only on the user defined FOV.}}

===$allow vertical dodge:===
{{Table3611|
*If set, allows ships to dodge weapons fire vertically as well as horizontally.}}

===$force beam turrets to use normal fov:===
{{Table3611|
*If set makes beam turrets use same FOV rules as other weapons do. Prevents beam from a turret from following the target beyond the turret's FOV}}

===$fix AI class bug:===
{{Table3611|
*Fixes a bug where AI class attributes are not set properly on ships if the AI class is set in the mission to something other than the default for the ship type. Set this to YES if you want attributes in [[Ai.tbl]] to mean anything at all.}}

===$turrets ignore targets radius in range checks:===
{{Table3611|
*TBD.}}

===$no extra collision avoidance vs player:===
{{Table3611|
*Disables the extra collision avoidance that AI normally uses against the player. Makes the AI more aggressive vs the player at close range (same treatment as vs other AI), although ship-ship collisions are slightly more likely.}}

===$perform fewer checks for death screams:===
{{Table3614|
*If set, the game will check if the dying ship is a player's wingman, before making it give a death scream.
Prior to revision 9119, this was "$perform fewer checks for death screams:", but the old version will still parse correctly.}}

===$advanced turret fov edge checks:===
{{Table3614|
*TBD.}}

===$require turrets to have target in fov:===
{{Table3614|
*TBD.}}

===$all ships manage shields:===
{{Table3613|
*Allows AI to manage shields on big ships}}

===$ai aims from ship center:===
{{Table3613|
*AI aims weapons using the center of the ship instead of the first gunpoint. If a convergence offset is specified for this ship in ships.tbl, AI aims using that as a reference point.}}

===$allow primary link at mission start:===
{{Table370|
*When set, no ships will link primaries for the first 30 seconds of a mission. In addition, ships will randomly not link for the first two minutes of a mission. Set this to NO to get rid of this often-problematic retail behavior. (Prior to revision 9119, this was called $allow primary link delay and defaulted to YES. The old method is still supported for compatibility.)}}

===$allow beams to damage bombs:===
{{Table3613|
*When set, beam weapons will be able to effectively intercept bombs. In addition, bombs flying through a beam path will get damaged and destroyed. Default: NO.}}

===$disable weapon damage scaling for player:===
{{Table3613|
*When set, Player weapon damage will no longer be scaled down when firing a non-huge primary against a ship with the "big damage" flag. Use with caution, as this may severely impact mission balance.}}

===$countermeasures affect aspect seekers:===
{{Table3613|
*TBD.}}

===$ai guards specific ship in wing:===
{{Table3615|
*If ordered to guard a ship in a wing (of which it is not a member), the AI will guard that specific ship instead of the entire wing (resulting in guarding the wing leader).}}

===$ai path mode:===
{{Table3613|
*Possible options are "normal" and "alt1". The alt1 mode differs from the normal behaviour in the following ways:
**1. No path shortcutting. Normal pathing AI will skip forward along a path to the furthest point it can reach. This is sometimes desirable, but makes it a lot harder to predict how the AI is going to behave at various points along a path. Turning this off also allows us to force the AI to straighten out, by giving it several waypoints in a more-or-less straight line. This is useful for such things as lining up a landing.
**2. No sliding when following paths. Docking still works, but there is some code that causes the AI to go full retard if it just misses a point: it turns towards the point in big, looping circles. This is apparently caused by passing a slide_vec value into ai_turn_towards_vector, which doesn't even seem to do what you'd expect it to do. Passing a null value instead turns off the stupid. (The behavior is fixed in alt1).
**3. Momentum taken into account when following paths. Path points will trigger sooner, proportional to the ship's speed and momentum. This prevents the AI from massively overshooting a waypoint, especially with high-damp ships.
**4. AI tries to follow the line between waypoints. Instead of just pointing at the next waypoint, the AI will fly a bit towards the line. This helps keep the AI actually on the path it claims to be following. See picture:[[Image:Altpaths.png]]
Blue is what happens with regular pathing. Red is the modified pathing: as you can see, it actively moves back towards the line.
**5. AI will respect "cap-waypoint-speed" when following paths (such as when docking or departing via bay).}}

===$default weapon select effect:===
{{Table3613|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$default ship select effect:===
{{Table3613|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$no warp camera:===
{{Table3615|
*When set, prevents the view from switching to the external camera when the player warps out.
*Note: this flag is deprecated and may get moved to another table without further notice.}}

===$fix ai path order bug:===
{{Table3615|
*When set, ship will follow its own waypoint path unless the wingleader has the same waypoint path and order.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$bay arrive speed multiplier:===
{{Table373|
*Causes all AI ships arriving from fighterbays (following a fighterbay path) to gradually accelerate, instead of immediately attempting to attain maximum speed. This can be used to prevent fighters from overshooting the fighterbay paths. The initial target speed is the maximum speed multiplied by the given value, with the multiplier gradually approaching 1.0 as the distance to the end of the path decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers.}}
}}

===$bay depart speed multiplier:===
{{Table373|
*Same as above, except for departures into fighterbays. The initial target speed is the maximum speed, with the target speed gradually approaching maximum speed multiplied by the given value as the distance to the fighterbay decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers.}}
}}

==Sample Entry==
*Retail FS2 behaviour

<pre>
#AI Profiles

$Default Profile: FS2 RETAIL

$Profile Name: FS2 RETAIL

$Player Afterburner Recharge Scale: 5, 3, 2, 1.5, 1
$Max Beam Friendly Fire Damage: 0, 5, 10, 20, 30
$Player Countermeasure Life Scale: 3, 2, 1.5, 1.25, 1
$AI Countermeasure Firing Chance: 0.2, 0.3, 0.5, 0.9, 1.1
$AI In Range Time: 2, 1.4, 0.75, 0, -1
$AI Always Links Ammo Weapons: 95, 80, 60, 40, 20
$AI Maybe Links Ammo Weapons: 90, 60, 40, 20, 10
$Primary Ammo Burst Multiplier: 0, 0, 0, 0, 0
$AI Always Links Energy Weapons: 100, 80, 60, 40, 20
$AI Maybe Links Energy Weapons: 90, 60, 40, 20, 10
$Max Missiles Locked on Player: 2, 3, 4, 7, 99
$Max Player Attackers: 2, 3, 4, 5, 99
$Max Incoming Asteroids: 3, 4, 5, 7, 10
$Player Damage Factor: 0.25, 0.5, 0.65, 0.85, 1
$Player Subsys Damage Factor: 0.2, 0.4, 0.6, 0.8, 1
$Predict Position Delay: 2, 1.5, 1.333,0.5, 0
$AI Shield Manage Delay: 5, 4, 2.5, 1.2, 0.1
$Friendly AI Fire Delay Scale: 2, 1.4, 1.25, 1.1, 1
$Hostile AI Fire Delay Scale: 4, 2.5, 1.75, 1.25, 1
$Friendly AI Secondary Fire Delay Scale: 0.4, 0.6, 0.8, 1.0, 1.2
$Hostile AI Secondary Fire Delay Scale: 1.4, 1.2, 1.0, 0.8, 0.6
$AI Turn Time Scale: 3, 2.2, 1.6, 1.3, 1
$Glide Attack Percent: 0, 0, 0, 0, 0
$Circle Strafe Percent: 0, 0, 0, 0, 0
$Glide Strafe Percent: 0, 0, 0, 0, 0
$Random Sidethrust Percent: 0, 0, 0, 0, 0
$Stalemate Time Threshold: 0, 0, 0, 0, 0
$Stalemate Distance Threshold: 0, 0, 0, 0, 0
$Player Shield Recharge Scale: 4, 2, 1.5, 1.25, 1
$Player Weapon Recharge Scale: 10, 4, 2.5, 2, 1.5
$Max Turret Target Ownage: 3, 4, 7, 12, 19
$Max Turret Player Ownage: 3, 4, 7, 12, 19
$Percentage Required For Kill Scale: 0.30, 0.30, 0.30, 0.30, 0.30
$Percentage Required For Assist Scale: 0.15, 0.15, 0.15, 0.15, 0.15
$Percentage Awarded For Capship Assist: 0.1, 0.2, 0.35, 0.5, 0.6
$Repair Penalty: 10, 20, 35, 50, 60
$Delay Before Allowing Bombs to Be Shot Down: 1.5, 1.5, 1.5, 1.5, 1.5
$Chance AI Has to Fire Missiles at Player: 0, 1, 2, 3, 4
$Max Aim Update Delay: 0, 0, 0, 0, 0
$Turret Max Aim Update Delay: 0, 0, 0, 0, 0
$Player Autoaim FOV: 0, 0, 0, 0, 0
$Detail Distance Multiplier: 0.125,0.25, 1.0, 4.0, 8.0

$big ships can attack beam turrets on untargeted ships: NO
$smart primary weapon selection: NO
$smart secondary weapon selection: NO
$smart shield management: NO
$smart afterburner management: NO
$allow rapid secondary dumbfire: NO
$huge turret weapons ignore bombs: NO
$don't insert random turret fire delay: NO
$hack improve non-homing swarm turret fire accuracy: NO
$shockwaves damage small ship subsystems: NO
$navigation subsystem governs warpout capability: NO
$ignore lower bound for minimum speed of docked ship: NO
$disable linked fire penalty: NO
$disable weapon damage scaling: NO
$use additive weapon velocity: NO
$use newtonian dampening: NO
$include beams for kills and assists: NO
$score kills based on damage caused: NO
$score assists based on damage caused: NO
$allow event and goal scoring in multiplayer: NO
$fix linked primary weapon decision bug: NO
$prevent turrets targeting too distant bombs: NO
$smart subsystem targeting for turrets: NO
$fix heat seekers homing on stealth ships bug: NO
$multi allow empty primaries: NO
$multi allow empty secondaries: NO
$allow turrets target weapons freely: NO
$use only single fov for turrets: NO
$allow vertical dodge: NO
$force beam turrets to use normal fov: NO
$fix AI class bug: NO
$turrets ignore targets radius in range checks: NO
$no extra collision avoidance vs player: NO
$perform fewer checks for death screams: NO
$advanced turret fov edge checks: NO
$require turrets to have target in fov: NO
$all ships manage shields: NO
$ai aims from ship center: NO
$allow primary link at mission start: NO
$allow beams to damage bombs: NO
$disable weapon damage scaling for player: NO
$countermeasures affect aspect seekers: NO
$ai path mode: normal
$no warp camera: NO

#End
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741 Re: New difficulty? - Feature request!]", ''Hard Light Productions Forums'', Hard Light Productions, 2007-12-15. Retrieved on [[December_27]], [[2007]].

[[Category:Tables]]

Controlconfigdefaults.tbl

2015-05-10T09:27:41Z

Zookeeper: Documented $Name

{{TableVersion|7478}}

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

[[Tables|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.
{{Table371|
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:===
{{Table373|
*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: [[Controlconfigdefaults.tbl#List of Bindings|List of Bindings]]
*Required
*Syntax: '''String'''

===$Key Default:===
*Key to set as default
*Valid entries: [[Controlconfigdefaults.tbl#Allowed Keys|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
*Syntax: '''String'''

===$Has XStr:===
*Whether or not the binding has an entry in [[strings.tbl]]
*'''1''' for yes, '''0''' for no
*Optional
*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
*Syntax '''String'''

==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

<pre>
#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
</pre>

==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'

[[Category:Tables]]

Game settings.tbl

2014-05-01T22:20:32Z

Zookeeper: Documented default volume level overrides

{{SCP_table}}

{{TableVersion|9771}}

The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally.

This table is one of the [[Modular Tables]] and can be extended with xxx-mod.tbm

[[Tables|List of Tables]]

==#CAMPAIGN SETTINGS==
Optional. This group contains various Campaign related settings and overrides. 

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String''''' 

==#Ignored Campaign File Names==
Optional. Defines which campaigns, if present, will not appear in the Campaign Room. Only single-player campaigns can be ignored. ''File extensions are required.''
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}

===$Campaign File Name:===
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String''''' 

==#HUD SETTINGS==
Optional. This group contains various HUD behavior settings and overrides 

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer''''' 
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

==#SEXP SETTINGS==
Optional. This group contains SEXP settings and overrides. 

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

==#GRAPHICS SETTINGS==
Optional. This group contains settings related to graphics. 

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high) }}

==#SOUND SETTINGS==
Optional. This group contains sound-related settings 

===$Default Sound Volume:===
{{Table371|
*Defines the default sound fx volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''1.0'''''}}

===$Default Music Volume:===
{{Table371|
*Defines the default music volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.5'''''}}

===$Default Voice Volume:===
{{Table371|
*Defines the default voice volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.7'''''}}

==#OTHER SETTINGS==
Optional. This group contains miscellaneous settings. 

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default ship select effect:===
{{Table3615|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS2", "FS1", and "off"}}

===$Default weapon select effect:===
{{Table3615|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS2", "FS1", and "off"}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting. Default is false.}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship. Default is false.}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

Multiplayer Getting Started Guide

2014-03-17T12:49:36Z

Zookeeper: Added note about "/multidata" renamed to "Broadcast Locally"

This detailed step-by-step guide will help you set up a current installation of FreeSpace Open for online multiplayer gaming, either on FS2NetD or through a direct IP connection. The guide is aimed at those who have little to no experience with FreeSpace Open and covers everything that might be needed to get multiplayer up and running, so more experienced users may want to just read the headlines to make sure they don't forget an important step.

==Pre-Game Preparation==
Before starting the actual game, there are a few outside factors that need to be taken care of first:
===FS2NetD Account Registration===
The first thing to do is to register your multiplayer account with FS2NetD. To do that, follow the steps below.

''Note: If you do not intend to play on FS2NetD, this step can be safely skipped as registration is not required for IP play, but registering is recommended nonetheless in case you change your mind.''
[[Image:FS2NetD_login.JPG|frame|FS2NetD login box|left]]

*'''Step 1:''' Go to the FS2NetD website, found here: [http://fs2netd.game-warden.com/ FS2NetD Home]

*'''Step 2:''' Click the '''Register''' button (''highlighted in image on the left'') in the login box on the top-left of the page. This brings you to the registration screen for new users. Do not write anything in the two boxes for Pilot and Password, those are for users who have already signed up.

*'''Step 3:''' You now have 3 fields to fill out, as shown in the image to the right. In the '''Pilot Name''' field, write the name of the pilot you intend to use when playing on FS2NetD. [[Image:FS2NetD_registration.JPG|frame|FS2NetD registration screen|right]]In the '''Password''' field, write a password of your choice. As always with passwords, it is a good idea to use one that is difficult to guess - If you need tips on that, here is a quick guide: [http://www.hr.mnscu.edu/faq/password.html Choosing a Good Password]. It would also be a very bad idea to reuse an existing password that is already being used for something sensitive. Then, in the '''Email''' field, put in a valid E-mail address. Upon completion of registration, a confirmation email will be sent to this address with a link you must follow to active your account, so ''do not'' put in a bogus address. If you do not wish to give up your usual email address, then you can use a web-based email service instead - As long as you can receive the mail and follow the link, you're good to go. Finally, click the '''Process Registration''' button (''highlighted in image to the right'').

*'''Step 4:''' Two mails have now been sent to the address you provided, one containing your login information (may want to write this down) and one containing an activation link. Open the one titled '''FS2NET Registration Authorization for: *****''', then follow the link inside to activate your FS2NetD account.

''Note: A pilot registered with FS2NetD can be used with all supported mods. It is not necessary to register separate pilots for FreeSpace, Beyond the Red Line and Wing Commander Saga, though you do have the option of doing so.''

===Firewall/Router Setup===
As FreeSpace Open uses port 7808 for multiplayer games, it is necessary to allow communication on this port to pass through your firewall and, if applicable, router unhindered. To do this, call up the control panel for your firewall/router and add an rule that opens up port 7808 to both ingoing and outgoing traffic, for both the TCP and UDP protocols. Detailed walkthroughs of how to do this for some common firewalls and routers can be found in the [[Port Forwarding]] article, so consult that if you have trouble figuring out how to do it.

Failure to do this will make you unable to host games, though depending on circumstances you may still be able to join games hosted by others.

===Config File Setup===
FreeSspace Open relies on a config file to tell it the location of the FS2NetD server, and depending on how you acquired the game this file may not be present. If you downloaded the game using Turey's [http://www.hard-light.net/forums/index.php/topic,42854.0.html Online Installer], or used the official installers to get either [[Beyond the Red Line]] or [[Wing Commander Saga]], then you will already have a correct version of this file appropriate to your installation and can skip this step. Otherwise, proceed.

The file in question, called <tt>fs2open_pxo.cfg</tt>, should be located in the /data/ folder under your FreeSpace installation directory and should contain the following two lines depending on what you have installed:

Standard FreeSpace Open installation:
fs2netd.game-warden.com
12000
Beyond the Red Line installation:
fs2netd.game-warden.com
12001
Wing Commander Saga installation:
fs2netd.game-warden.com
12003
The Babylon Project installation:
fs2netd.game-warden.com
12004
If this file is '''not''' present, or does not contain the exact lines above, then create a new text file in the /data/ folder, copy the appropriate lines to it, and save it as <tt>fs2open_pxo.cfg</tt>.

''Note: The current IP address of fs2netd.game-warden.com is'' <tt>64.92.160.250</tt>'', so if the first line says that instead then it will still work. However, using the URL is safer in case the IP address changes.''

''Note: For those using the [[MediaVP]]s with a standard FreeSpace Open installation, a version of this file containing the same two lines may also be found in /mediavps/data/.''

===Getting the Validated Missions===
As the next step before moving in-game, you should download the multiplayer mission package. This package contains extra multiplayer missions for FreeSpace 2, all of which are validated for online play over FS2NetD. This means that stats from these missions will be saved by the FS2NetD server after each game.

To use them properly, first download the <tt>multi-mission-pack.vp</tt> file (''link below'') and save it to a separate directory under your FreeSpace 2 installation - For the purposes of this guide, we will use the directory '''<tt><FreeSpace 2 location>/multimissions/</tt>'''. Then select that directory as a mod in the launcher (''see next section''). There is also an optional voice pack addon for those missions which, if you choose to download it, should be placed in the same directory as the mission package.

*[http://web.archive.org/web/20090815000000*/http://www.fszmirror.com/files/multi-mission-pack.vp Mission package]
*[http://web.archive.org/web/20081022231035/http://www.fszmirror.com/files/multi-voice-pack.vp Voice package]

===Launcher Setup===
Before being able to play online, your internet connection must be correctly configured in the launcher. To do that, follow the steps below:
[[Image:Launcher_network.JPG|frame|Network tab in the FreeSpace Open launcher|left]]

*'''Step 1:''' Start the FreeSpace Open launcher and go to the '''Network''' tab (''pictured left'').

*'''Step 2:''' In the '''Internet Connection''' field, choose ''Dialup Networking'' if you are using a standard or ISDN modem to connect to the internet. If you are using broadband connection such ADSL, Cable or (heavens forbid) a Fiber-Optic connection, choose the ''LAN/Direct Connection (And AOL)'' option.

*'''Step 3:''' In the '''Connection Speed''' field, simply choose the option that best fits your connection. Note that faster cable connections may belong in the ''T1, ADSL, T3, etc'' category as speeds have been upped significantly over the last few years.

''Note, do '''not''' put anything into the '''Force local port''' or '''Force IP address''' fields at the bottom of the '''Network''' tab. Leave them as is. Doing otherwise can make it impossible for you to connect to FS2NetD.''

*'''Step 4:''' Now go to the '''MOD''' tab (''just above the highlighted Network tab in the image'').

*'''Step 5:''' In the '''MOD''' tab, click the '''Select MOD''' button, select the '''<tt>multimissions</tt>''' folder from the list that
pops up, and click '''OK'''.

*'''Step 6:''' Click '''Apply''' at the bottom-right of the launcher to save the settings.

==In-Game Preparation==
With the above preparations taken care of, there are still a few in-game things to take care of.
===Creating a Multiplayer Pilot===
The first thing to do is to create a multiplayer pilot, by following these steps:

[[Image:Pilot_select_multi.JPG|frame|Pilot selection screen in standard FreeSpace|right]]
*'''Step 1:''' Start the game using the launcher, and you will arrive at the pilot selection screen (''pictured right'').

*'''Step 2:''' Click on the '''Multi''' button in the top-right corner (''highlighted'') to go to the multiplayer pilot screen.

*'''Step 3:''' Click on the '''Create''' button in the bottom-left corner (''highlighted'') as when creating a normal pilot. However, since we are now on the multiplayer screen, it will create a multiplayer pilot instead.

*'''Step 4:''' Type in the pilot name you used when you [[Multiplayer Getting Started Guide#FS2NetD Account Registration|registered your FS2NetD account]], and hit enter to create the pilot. It is not a problem if this name is the same as one of your singleplayer pilots, as they are stored separately.

*'''Step 5:''' Select the pilot by clicking the name, and click '''Select''' to enter the game.

''Note: If you can't remember the pilot name you used when you registered, check your email - Upon registration, an email titled '''FS2NET Login Information For: *****''' is sent to the email address you provided. The name in the title (here replaced with asterisks) is the pilot name you need.

[[Image:Multiplayer_options_navbar.JPG|frame|Options screen navigation bar|right]]
===Multiplayer Setup===
Once in the game, go to the options screen ('''F2'''), then click on the '''Multi''' button (''highlighted in image'') in the top navigation bar. Here there are a number of settings to go over, some which vary depending on whether you want to play FS2NetD games or IP games, and some which apply to both.

====Global Settings====
These settings apply to both IP and FS2NetD games.
[[Image:Multiplayer_protocol.JPG|frame|Protocol selection|left]]

*'''Protocol Selection:''' These two buttons, found in the upper-left corner of the options screen, determine the network protocol used by the game to communicate with other machines. Set this to '''TCP''' as shown in the image to the left. The '''IPX''' protocol, while once popular, is no longer widely used and has been superceded by '''TCP''' in practically all areas, so unless specifically instructed otherwise, always leave this setting on '''TCP'''.

[[Image:Multiplayer_multidata.JPG|frame|Multidata button|left]]

*'''Multidata:''' This button, found in the middle-left of the options screen, currently has no effect. Leave if '''Off''' as shown in the image to the left.

{{Table371|This has been renamed to "Broadcast Locally", which is presumably the intended original name.}}

[[Image:Multiplayer_object_update.JPG|frame|Object Update buttons|right]]

*'''Object Update:''' These four buttons, found in the upper-right part of the options screen, determine the rate at which your machine receives updates on objects in a mission. Most of the time, you will want to leave this on '''Low''' (''as shown in the image to the right''), as it can cause severe stress for a server if everyone in a game has this set to High, which in turn causes lag. So while it may seem counterintuitive, having updates set to '''Low''' does in fact make for a better multiplayer experience. There is one exception to this - When you are hosting a game. In this case, and in this case only, set object update to '''High'''. Just remember to set it back to '''Low''' once you are done playing host.

[[Image:Multiplayer_pilot_squad_images.JPG|frame|Pilot/Squad images buttons|right]]

*'''Pilot/Squad Images:''' These buttons, in the middle-right of the options screen, determine whether you will automatically download any pilot and squadron images used by other players when you connect to a server, if you don't already have them. The recommended setting is '''Yes''' as shown in the image to the right, but it is up to you whether you want to download them or not.

[[Image:Multiplayer_transfer_missions_new.JPG|frame|Transfer missions buttons|right]]

*'''Transfer Missions:''' These two buttons, in the middle-right part of the options screen, determine the location to which auto-transferred missions are saved. Always leave it on '''/Missions''' as shown in the image to the right, as selecting /Multidata can currently leave you unable to play the missions that are automatically transferred.

[[Image:Multiplayer_cache_flush.JPG|frame|Cache Flush buttons|right]]

*'''Cache Flush:''' These buttons, in the lower-right part of the options screen, determine when the multiplayer cache will be cleared. With the size of today's harddrives, it is best to simply leave this on '''Never''' as shown in the image to the right, as it may cut waiting times a little when joining a game with people you have played with before.

====FS2NetD Specific Settings====
These settings apply only when you want to play games over the FS2NetD service. In the PXO Login box, found at the bottom-left area of the options screen and pictured below, you need to type in the information you used when you [[Multiplayer Getting Started Guide#FS2NetD Account Registration|registered your FS2NetD account]]:
[[Image:Multiplayer_pxo.JPG|frame|PXO login box|left]]

*First, make sure the '''PXO''' button in the top-left of the login box is turned on.

*In the '''Login''' field, write the name of the FS2NetD multiplayer pilot you are currently using.

*In the '''Password''' field, write the password you used when you registered that pilot.

*Finally, if you have joined a multiplayer squadron, type the name of that squadron in the '''Squadron''' field. This last field is optional, so it is OK to leave it blank for those who are not in a squadron.

With this done, you will automatically enter the multiplayer lobby when you click on the Ready Room from the main hall, and see any FS2NetD games that are currently running.

''Note: If you can't remember the pilot name or password you used when you registered, check your email - Upon registration, an email titled '''FS2NET Login Information For: *****''' is sent to the email address you provided. This email contains both the name and the password you need for your FS2NetD login.

====Direct IP Specific Settings====
These settings only apply when you want to play games using a direct IP connection to the host computer. To do this, you need to first enter the IP address of the server you want to join and then turn off PXO, as shown below.
[[Image:Multiplayer_IP_address.JPG|frame|IP addresses box|left]]

'''Add an IP Address:'''

*First, click the '''Add''' button (''highlighted''), and a marker will appear after '''IP Address''' at the top of the box.

*Next, in the place where '''IP Address of Server''' appears in the image, type in the IP address of the computer hosting the game you want to join and hit enter, and the address will appear in the box below. You do not need to select the address after adding it.

[[Image:Multiplayer_pxo_off.JPG|frame|PXO button, off|left]]

'''Deselect PXO:'''
*To deselect PXO, simply turn off the PXO button in the PXO Login box, as shown to the left.

With this done, you will automatically enter the multiplayer lobby when you click on the Ready Room from the main hall, and see any games that are currently being hosted on servers whose IP address you have added.

''Note: When hosting an IP game, you do not need to enter the IP addresses of the client machines. However, you will need to supply them with '''Your''' IP address so they can add you to their list. To find your IP address, you can either go to the '''Support''' section for the connection you are using to access the internet, or go to [http://whatismyip.com/ whatismyip.com] to see it online.''

'''A quick overview of the rest of the IP Addresses box:'''

* The two '''Up''' and '''Down''' arrows on the left of the box allow you to scroll it if you have added a lot of IP addresses.
* The '''Rem.''' button next to the Add button allows you to delete an IP address you no longer need. The address to be deleted is selected by clicking on it, after which it will be highlighted as shown with the first of the two addresses in the image above.

==Joining a Game==
Once all the different options are set up to your satisfaction, select your multiplayer pilot and enter the Ready Room ('''R'''). This takes you to the multiplayer lobby.

===Lobby Screen===
[[Image:Multiplayer_server_list.JPG|frame|Server list with a game in the forming stage|right]]
The first thing you will see when you enter the multiplayer lobby is the server list, which takes up the top two-thirds of the screen. If one or more games are running, as shown in the image above, you are presented with a number of facts about each game, sorted into columns - If no games are currently running, you will be treated to the message shown in the second image below. Here's what the information in each column means:

*'''Status:''' This represents the stage the game is currently at, and can be either '''Forming''', '''Briefing''', '''Playing''', or '''Debriefing'''. You can only join games in the '''Forming''' stage.

*'''Server:''' The server column shows you several different things:
**The green symbols on the left indicate the type of game - One group of three arrows is '''Coop''', two opposing groups of three arrows (''see above image'') is '''Team vs Team''', and 4 single arrows pointing towards eachother is '''Dogfight'''.[[Image:Multiplayer_server_list_none.JPG|frame|Server list with no games running|right]]
**The green text next to the symbols shows the speed of host's internet connection.
**And finally, the grey/blue text to the right of that shows the name of the game and the mission chosen by the host.

*'''Players:''' The players column shows the number of players currently in the game.

*'''Ping:''' And finally, the ping column shows the quality of your connection to the host, measured by the response time in milliseconds.

[[Image:Multiplayer_refresh.JPG|frame|Server list refresh button|left]]

At the bottom-left of the server list window is a button labelled '''Refresh''' (''pictured left''), which lets you refresh the server list to see if any new games have started since you logged into the lobby. Below that, you will find a text box containing a short description whichever mission the server you have selected is running, and on the left side of the list are scroll buttons in case more servers are running than the window can fit.

[[Image:Multiplayer_join.JPG|frame|right]]

Once you have looked over the available information and decided on which game to join, simply click on the game in the server list, and then click the '''Join''' button in the bottom-right of the lobby screen (''shown to the right''), and you will enter the game. Once you are in a game, you can chat with the other participants and ask any questions you might have regarding the game you have entered. Congratulations, you are now playing a FreeSpace Open multiplayer game.

Once the game enters briefing, it is much the same as in a regular single player mission. The main difference is that you can still chat with the other players while watching the briefing, and you will have to wait for all players to commit to the mission before the mission enters flight mode.

[[Category:Multiplayer]]

Species defs.tbl

2014-02-07T14:47:55Z

Zookeeper: Clarified +Shield_Hit_ani slightly

{{SCP_table}}

{{TableVersion|10131}}

The '''species_defs.tbl''' is a new table added by the Source Code Project which allows the addition of new species types in addition to Terran, Vasudan and Shivan, or to replace these three species. New species can have individual briefing icons, thruster glows, shield hit anis, debris fields, and [[FRED]] menu colours. Any new species added here must be added to [[icons.tbl]], [[asteroid.tbl]] and [[sounds.tbl]] if the game is to work.

This table is one of the [[Modular Tables]] and can be extended with xxx-sdf.tbm

[[Tables|List of Tables]]

==Species Entry==

===$Species_Name:===
{{Table3610|
*Defines the name of the species.
*Syntax: '''String'''
**Example: ''Shivan''}}

===$Default IFF:===
{{Table3610|
*Defines the species default IFF in FRED.
*Syntax: '''String''', name of the IFF, either as default IFF types or as define in [[iff_defs.tbl]]
**Example: ''Hostile''}}

===$FRED Color::===
{{Table3610|
*Also '''$FRED Colour:'''
*Defines the color used in FRED for this species
*If not defined the fred defaults color to black ( 0, 0, 0 )
*Syntax: ( '''Color''' ), three '''integers''', 0 to 255, red, green and blue respectively
**Example: ( 255, 0, 0 )}}

===+Debris_Texture:===
{{Table3610|
*Defines the name of the standard texture applied to particle-like impact-effect and 'vaporized' ship debris.
*Syntax: '''String''', filename
**Example: ''debris01c''}}

===+Shield_Hit_ani:===
{{Table3610|
*Defines the name of the ani file projected to a species shield mesh when hit.
*Syntax: '''String''', filename
**Example: ''shivanshield''}}

===$ThrustAnims:===
{{Table3610|
*'''+Normal:''' or '''+Pri_Normal:'''
**Defines name of standard thruster animation.
**This maps the image onto the mesh thrusters.
**Syntax: '''String''', filename or ''<none>''
***Example: ''thruster03''
*'''+Afterburn:''' or '''+Pri_Afterburn:'''
**Defines name of afterburn thruster animation.
**This maps the image onto the mesh thrusters.
**Syntax: '''String''', filename or ''<none>''
***Example: ''thruster03a''
*'''+Sec_Normal:'''
**Defines name of secondary standard thruster animation.
**This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
**Syntax: '''String''', filename
***Example: ''thruster02-03''
*'''+Sec_Afterburn:'''
**Defines name of secondary afterburn thruster animation.
**This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
**Syntax: '''String''', filename
***Example: ''thruster02-03a''
*'''+Ter_Normal:'''
**Defines name of tertiary standard thruster animation.
**This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers in size.
**Syntax: '''String''', filename
***Example: ''thruster03-03''
*'''+Ter_Afterburn:'''
**Defines name of tertiary afterburn thruster animation.
**This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers.
**Syntax: '''String''', filename
***Example: ''thruster03-03a''}}
{{Table3613|
*'''+Dist_Normal:'''
**Defines name of normal thruster distortion envelope animation.
**This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
**Syntax: '''String''', filename
***Example: ''thruster02-03''
*'''+Dist_Afterburn:'''
**Defines name of afterburner thruster distortion envelope animation.
**This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
**Syntax: '''String''', filename
***Example: ''thruster02-03a''}}

===$ThrustGlows:===
{{Table3610|
*'''+Normal:'''
**Defines name of standard thruster glow bitmap.
**Syntax: '''String''', filename or ''<none>''
***Example: ''thrusterglow03''
*'''+Afterburn:'''
**Defines name of standard thruster glow bitmap.
**Syntax: '''String''', filename or ''<none>''
***Example: ''thrusterglow03a''}}

===$AwacsMultiplier:===
{{Table3610|
*Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number.
*Syntax: '''Float''', (multiplier)
**Example: ''1.25''}}

===$Countermeasure Type:===
{{Table371|
*Works just like the $Countermeasure Type: on a ship class basis. If you specify one for the species, you won't have to specify one for each ship class of that species.}}

==Sample Entry==

<pre>
#SPECIES DEFS

;------------------------
; Terran
;------------------------
$Species_Name: Terran
$Default IFF: Friendly
$FRED Color: ( 0, 0, 192 )
$MiscAnims:
+Debris_Texture: debris01a
+Shield_Hit_ani: shieldhit01a
$ThrustAnims:
+Normal: thruster01
+Afterburn: thruster01a
$ThrustGlows:
+Normal: thrusterglow01
+Afterburn: thrusterglow01a
$AwacsMultiplier: 1.00

;------------------------
; Vasudan
;------------------------
$Species_Name: Vasudan
$Default IFF: Friendly
$FRED Color: ( 0, 128, 0 )
$MiscAnims:
+Debris_Texture: debris01b
+Shield_Hit_ani: shieldhit01a
$ThrustAnims:
+Normal: thruster02
+Afterburn: thruster02a
$ThrustGlows:
+Normal: thrusterglow02
+Afterburn: thrusterglow02a
$AwacsMultiplier: 1.25

;------------------------
; Shivan
;------------------------
$Species_Name: Shivan
$Default IFF: Hostile
$FRED Color: ( 192, 0, 0 )
$MiscAnims:
+Debris_Texture: debris01c
+Shield_Hit_ani: shieldhit01a
$ThrustAnims:
+Normal: thruster03
+Afterburn: thruster03a
$ThrustGlows:
+Normal: thrusterglow03
+Afterburn: thrusterglow03a
$AwacsMultiplier: 1.50

#END
</pre>

[[Category:Tables]]

Weapons.tbl

2014-01-11T23:08:03Z

Zookeeper: Documented new features

{{TableVersion|9215}}

The '''weapons.tbl''' defines all of the weapon classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-wep.tbm

[[Tables|List of Tables]]

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen and in Tech Room for the weapon.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the external weapon model
*Syntax: '''''Float'''''}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model
*Syntax: '''''Float'''''}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color. ''(needs confirmation)''

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves
*Syntax: '''''Float''''', damage}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after travelling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Homing:===
'''This option is exclusive to secondaries.'''

Defines if the bolts/missiles in question is homing
*The bolts of primaries will turn to face their target if this option is set to YES... but is otherwise the same as a normal bolt ( when the option is set to NO ).

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how well the missile maneuvers. Is defined as the number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
*Syntax: '''''Float''''', seeker strength}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150
***Max: 0.5 (Resets to default if set over 0.5)}}

===$Acceleration Time::===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit::===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be travelling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO currently parses but doesn't use the value, and prints a warning in the log saying that the value will not be used.}}
}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$TrackingSnd===
{{Table3615|
*The looping sound played when this weapon tracks a target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when this weapon has locked onto its target.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played when the missile is currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters

===$Dinky impact explosion:===
{{Table3610|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky impact explosion radius:===
{{Table3610|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$EMP Intensity:===
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit
**Syntax: '''''Float'''''

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit
**Syntax: '''''Float'''''

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targeting beam that is used to trigger SSMs. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only needed when editing beams that already exist in other tables.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
*Defines a pattern of ammo to substitute for primary or secondary weapons. '''$substitute:''' can be repeated any number of times. ''+period'' and ''+index'' will grow the pattern array anytime something does not fit so any whole number will be accepted. If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.
**Syntax: '''''Weapon Name'''''
*'''+period:'''
*Substitute '''Weapon Name''' every ''period'' shots. '''Mutually exclusive with ''+index'''''
**Syntax: '''''Positive Integer'''''
*'''+offset:'''
*Shift period pattern ''offset'' shots. '''Must be used with ''+frequency'''''
**Syntax: '''''Positive Integer'''''
*'''+index:'''
*Substitute the '''Weapon Name''' at ''index'' in the shot pattern. '''Mutually exclusive with ''+period'''''
**Syntax: '''''Positive Integer'''''
}}
{{Table3615|
*Turrets support added.
}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Scripting.tbl

2013-12-27T18:22:10Z

Zookeeper: Documented $On Action and $On Action Stopped hooks and the $Action condition

{{SCP_table}}

{{TableVersion|4500}}

The '''scripting.tbl''' is used for scripting special features like alternate HUDs or ship viewer into the game.

This table is one of the [[Modular Tables]] and can be extended with xxx-sct.tbm

[[Tables|List of Tables]]

==General Info==
*Scripting table consist of several sections identified by a hash mark preceeding the section name (i.g. #Global Hooks)
*All sections ''must'' end with #'''End'''
*All sections are optional
*Most entries are optional
*Scripting hooks are '''not''' executed on a separate thread (at least as of this writing). They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. Therefore, large and complicated scripts will most likely cause noticeable lag or slowdown when executed.
{{Template:Note|1=Information on this page does not apply to pre-3.6.10 builds}}
 

==Useful references==
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Scripting functions]]'''
*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==Prerequisites==

===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 

===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 

====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 

==Sections==

===#Global Hooks===
Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 

====$Global:====
Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
 

====$Splash:====
This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
 

=====+Override:=====
Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
 

====$GameInit:====
This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
 

====$Simulation:====
This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
 

====$HUD:====
The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
 

=====+Override:=====
Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.
 

===#State Hooks===
In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 

=====$State:=====
Specifies the state name. A full list of states is located here: ''[[List of Game States]]''

=====$Hook:=====
Executed after all of the state code has been executed, but before the game frame is actually drawn.

======+Override:======
Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

===#Conditional Hooks===
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

;Format

;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

====Conditions====

=====$State:=====
Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission.
*The full list of states can be found here: ''[[List of Game States]]''

=====$Campaign:=====
Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).

=====$Mission:=====
Controls execution based on the filename of the last mission to have started. This condition will remain true even after the mission has been exited until another mission is started.

=====$Object Type:=====
Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".

=====$Ship:=====
Defines a specific ship (name) that the action will apply for.

=====$Ship class:=====
Defines a specific ship class (name) that the action will apply for.

=====$Ship type:=====
Defines a specific ship type (name) that the action will apply for.

=====$Weapon class:=====
Defines a specific weapon class (name) that the action will apply for.

=====$KeyPress:=====
Defines a specific key that the action will apply for.
*Experimental.

=====$Action:=====
{{Table371|
Defines a specific control that the action will apply for. For example "Fire Primary Weapon" or "Match Target Speed".
}}

====Actions====

=====$On Game Init:=====
Executes immediately after game has been started.
::* No associated hook variables.

=====$On Splash Screen:=====
Executes when initial game splash screen is shown
::* No associated hook variables.

=====$On State Start:=====
Executed when specified game state starts
::* No associated hook variables.

=====$On Frame:=====
Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.

=====$On Key Pressed:=====
Executed when specified key is pressed
::* '''Key''', The pressed key

=====$On Key Released:=====
Executed when specified key is released
::* '''Key''', The released key

=====$On Mouse Moved:=====
Executed when mouse is moved
::* No associated hook variables.

=====$On Mouse Pressed:=====
Executed when mouse button is pressed
::* No associated hook variables.

=====$On Mouse Released:=====
Executed when mouse button is released
::* No associated hook variables.

=====$On State End:=====
Executed when specified game state ends
::* No associated hook variables.

=====$On Mission Start:=====
Executed when mission starts
::* No associated hook variables.

=====$On Gameplay Start:=====
{{Table3615|
Executed when the gameplay part of a mission starts
::* No associated hook variables.}}

=====$On HUD Draw:=====
Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)

=====$On Ship Collision:=====
Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)

=====$On Weapon Collision:=====
Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)

=====$On Debris Collision:=====
Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)

=====$On Asteroid Collision:=====
Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)

=====$On Object Render:=====
Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)

=====$On Warp In:=====
Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)

=====$On Warp Out:=====
Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)

=====$On Death:=====
*Currently only valid for ships.
Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists

=====$On Mission End:=====
Run on mission end.
::* No associated hook variables.
=====$On Weapon Equipped:=====
{{Table3613|
Runs once each frame, for every ship that has the weapon defined in the $Weapon class condition equipped.
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Fired:=====
{{Table3613|
Runs once when a ship fires a weapon defined in the $Weapon class condition
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Selected:=====
{{Table3613|
Runs once when a bank with a weapon defined in the $Weapon class condition is selected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Deselected:=====
{{Table3613|
Runs once when a bank with a weapon defined in the $Weapon class condition is deselected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Turret Fired:=====
{{Table3615|
Executed when a turret fires.
::* '''Ship''', the parent ship
::* '''Weapon''', the weapon which was fired
::* '''Target''', the intended target
}}

=====$On Ship Arrive:=====
{{Table371|
Executed when a ship arrives.
::* '''Ship''', the arriving ship
::* '''Parent''', the ship acting as the anchor when arrival location is "in front of ship", "near ship" or "docking bay"; nil or invalid handle otherwise
}}

=====$On Action:=====
{{Table371|
Executed when an action is triggered, regardless of which key or button it is bound to. Does currently not trigger on mouse or joystick movements.
::* '''Action''', the textual description of the action (for example "Fire Primary Weapon" or "Match Target Speed")
}}

=====$On Action Stopped:=====
{{Table371|
Executed when a continuous action is released (for example "Fire Primary Weapon", "Turn Left" or "Afterburner").
::* '''Action''', the textual description of the action
}}

==Misc. Hook Variables:==

===Viewer===
*Active if (non-player) viewing object is valid

===Player===
*Active if player obj is valid
 

==Examples==

See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Command-Line Reference

2013-12-18T23:11:31Z

Zookeeper: Added a note of the FoV magic number multiplier

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

Once you launch and choose a pilot within the game, you will immediately have begun to host a game. This can be used in conjunction with several options to customize the game you create: -closed, -restricted, -password, -gamename, -allowabove, and -allowbelow. -startgame has no effect when -standalone is used.

See related: [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]] [[Command-Line_Reference#-gamename|-gamename]] [[Command-Line_Reference#-allowabove|-allowabove]] [[Command-Line_Reference#-allowbelow|-allowbelow]]

====-closed====
'''"Start Hosted Server as Closed"'''

Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
'''"Host Confirms Join requests"'''

Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder—or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
'''"Disables Flight Deck option"'''

Disables return to the flight deck screen after a mission completes.

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables. The errors are there for a reason.

====-safeloading====
Loads missions the old way. Typically safer, but slower.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.

====-loadallweps====
'''"Load all weapons, even those not used"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This does not mean that your card has this much memory, and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-ambient_factor====
This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-spec_exp====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16. However, 11 is recommended. This is a relative value.

====-spec_point====
This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0. However, 0.6 is recommended. This is a relative value.

====-spec_static====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, is 0.8 recommended. This is a relative value.

====-spec_tube====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, 0.4 is recommended. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behavior, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''.
If ''Freespace2/moddir/[[mod.ini]]'' exists it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#Files located inside vp archives. (These vp archives are "similar" to zip archives. They just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order, so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter that this ''Mission.fs2'' is also inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.
# This flag is also used by [[Portal:FRED|FRED]]. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

'''Note: for peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.'''

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame.

Takes one argument string, the name to be assigned to the game being created.

This argument does nothing when used with -standalone. To set the name for a standalone server, see [[Multiplayer(Main)#Standalone Servers|Standalone Servers]].

See related:   [[Command-Line_Reference#-startgame|-startgame]]   [[Multiplayer(Main)#Standalone Servers|Standalone Servers]]

====-password====
Specifies the password for a standalone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a standalone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a standalone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

[[Category:Lists]]
[[Category:Source Code Project]]

Controlconfigdefaults.tbl

2013-12-13T22:18:18Z

Zookeeper: Documented multiple control presets

{{TableVersion|7478}}

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

[[Tables|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.
{{Table371|
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.}}

==$Bind Name:==
*Name of the bind or action to modify the default key of.
*Valid entries: [[Controlconfigdefaults.tbl#List of Bindings|List of Bindings]]
*Required
*Syntax: '''String'''

===$Key Default:===
*Key to set as default
*Valid entries: [[Controlconfigdefaults.tbl#Allowed Keys|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
*Syntax: '''String'''

===$Has XStr:===
*Whether or not the binding has an entry in [[tstrings.tbl]]
*'''1''' for yes, '''0''' for no
*Optional
*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
*Syntax '''String'''

==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

<pre>
#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
</pre>

==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'

[[Category:Tables]]

Animation Code

2013-12-03T17:34:15Z

Zookeeper: Documented fighterbay +sub_types

{{TableVersion|5211|5332}}

Known commonly as Bob's animation code as the code was written by Bobboau. Enables submodels defined in [[ships.tbl]] or in any related modular table to be animated in game. Animation code is included to the subsystem entry in similar manner as with [[Animation_Code#Setting_Turret_Angle|multipart turrets]]

==Important Note: "$triggered:" Subobject Property==
For any animated subobject other than turrets, you must have "$triggered:" written in the subobject properties field of that subobject for the model file (POF) that you wish to animate. See [[Subsystem]] for more information on Subsystem flags and options.

==$Animation:==
{{Table3610|*Animation classes are defined in submodels description
*Syntax: '''String''', animation ''class''
*'''Available animation types:'''
**Triggered}}

===Animation Type===
{{Table3610|
*Animation type defines when the animation is used
*Currently supported animation types:
**'''initial'''
***Animation code is started when the mission begins. Unlike other animation types this requires only '''angle''' to be set
**'''docking'''
***Animation code is started when ship starts docking
**'''docked'''
***Animation code is started when ship is docked
**'''primary-bank'''
***Animation code is started when a primary bank is selected (armed)
**'''secondary-bank'''
***Animation code is started when a secondary bank is selected (armed)
**'''fighterbay'''
***Animation code starts when ship launches from or receives others through its fighterbay
**'''afterburner'''
***Animation code is started when ships afterburner is engaged
**'''turret-firing'''
***Animation code is started when selected turret is firing
**'''scripted'''
***Animation code is started when it is triggered with scripts (see [[scripting.tbl]])
{{Table3615|
*'''turret-fired'''
**Animation code is started whenever a turret has fired (Useful for recoil or similar things)}}
*Syntax: '''$type:''' ''Type''}}

===Animation Sub-Type===
{{Table3610|
*Optional more accurate descriptor for the animation type
*'''primary-bank''' or '''secondary-bank'''
**Syntax: '''+sub_type:''' ''Value'', 0 is the 1st weapon bank, 1 is the 2nd weapon bank, etc.
*'''turret-firing'''
**Syntax: '''+sub_type:''' ''Value'', model number of the turret that triggers the animation. NOTE: This feature currently does not work on multipart turrets.
{{Table371|
*'''fighterbay'''
**Syntax: '''+sub_type:''' ''Value'', number of the bay path that must be used for this animation to trigger. A negative can be used to allow the animation to trigger only when the path is '''not''' used. The number of a bay path is the number in its name; for example, use 3 to restrict the animation to the path $bay03, or -1 to prevent it from triggering when the path $bay01 is used.}}
}}

===Animation Code===

====Initial type====
{{Table3610|
*'''+delay:'''
**Defines how long til the trigger starts.
**Syntax: '''Integer''', milliseconds
*'''+reverse_delay:'''
**Syntax: '''Integer'''
*'''+absolute_angle:''' OR '''+relative_angle:'''
**Defines the rotation degrees with three floats that give the x, y, and z. Absolute means in world terms; relative means relative to the ship. So a 90 degree angle on the ship would always be straight up in relative degrees; it would vary depending how the ship was rotated in absolute degrees.
**Syntax: '''Vector''', three ''floats'' in degrees, x, y, z respectively
**Example: ''90,180,0''
*'''+velocity:'''
**Defines subobject rotation speed, in relative terms. Defined with x, y and z floats.
**Syntax: '''Vector''', three ''floats'', x, y, z respectively
*'''+acceleration:'''
**Defeines acceleration speed of subobject rotation. Defined with three floats, x, y and z
**Syntax: '''Vector''', three ''floats'', x, y, z respectively
*'''+time:'''
**Defines time for object to rotate, move, whatever.
**Syntax: '''Integer''', milliseconds}}

====Other types====
{{Table3610|
*'''+delay:'''
**Defines how long til the trigger starts.
**Syntax: '''Integer''', milliseconds
*'''+reverse_delay:'''
**Defines how long til the trigger starts.
**Syntax: '''Integer''', milliseconds
*'''+absolute_angle:''' OR '''+relative_angle:'''
**Defines the rotation degrees with three floats that give the x, y, and z. Absolute means in world terms; relative means relative to the ship. So a 90 degree angle on the ship would always be straight up in relative degrees; it would vary depending how the ship was rotated in absolute degrees.
**Syntax: '''Vector''', three ''floats'' in degrees, x, y, z respectively
**Example: ''90,180,0''
*'''+velocity:'''
**Defines subobject rotation speed, in relative terms. Units are in degrees per second. Defined with x, y and z floats.
**Syntax: '''Vector''', three ''floats'', x, y, z respectively
*'''+acceleration:'''
**Defines acceleration speed of subobject rotation. Units are in degrees per second squared. Defined with three floats, x, y and z
**Syntax: '''Vector''', three ''floats'', x, y, z respectively
*'''+time:'''
**Defines the amount of time that the object will rotate, move, whatever.
**Syntax: '''Integer''', milliseconds
*'''$Sound:''' (Does not work with 'initial' animations)
**Defines sounds that are played with the animation
**'''+Start:'''
***Defines the sound that is played when animation starts
***Syntax: '''Integer'''
**'''+Loop:'''
***Defines the sound that is played when animation is going on
***Syntax: '''Integer'''
**'''+End:'''
***Defines the sound that is played when animation stops
***Syntax: '''Integer'''
**'''+Radius:'''
***Defines the distance from the submodel where the sound is audible
***Syntax: '''Float''', meters}}

==Animation Examples==

===Setting Turret Angle===
*Animation code can be used to set multipart turrets barrel angle at the beginning of the mission
*'''Animation Class''' = triggered
**The only one available
*'''Animation Type''' = initial
**As we want the barrels to align themselves at the beginning of the mission
*'''Animation Code'''
**'''+relative_angle:''' is good for this purpose
**Notes about angles:
***First value is used to determine the turret's barrels deviation from the turrets normal. So barrel elevation in degrees is ( 90 - the first value ).
***Second value is used to determine the turret facing. With ''0'' the turret facing is in the normal setting and with ''180'' turn the turret completely around. Do note that turrets on the underside of the model normally face backwards, so to get these turrets pointing forwards the second value has to be set to 180.

====Examples====

<pre>
$Subsystem: turret02,0.833,1.0
$Default PBanks: ( "Terran Turret" )
$animation: triggered
$type: initial
+relative_angle: 90,180,0
</pre>

<pre>
$Subsystem: DockingClaw1, 0, 1.0
$Flags: ( "untargetable" )
$animation: triggered
$type: docking ;;The claw opens on approach
+sub_type: 0 ;;The number of the associated dock (works with multidocking)
+delay: 0
+relative_angle: 0,0,90
+velocity: 0,0,10
+acceleration: 0,0,5
+time: 2000
$animation: triggered
$type: docked ;;The claw closes once docked
+sub_type: 0
+delay: 0
+relative_angle: 0,0,-90
+velocity: 0,0,10
+acceleration: 0,0,5
+time: 2000
</pre>

[[Category:Tables]]

Scripting.tbl

2013-12-03T16:17:18Z

Zookeeper: Documented $On Ship Arrive

{{SCP_table}}

{{TableVersion|4500}}

The '''scripting.tbl''' is used for scripting special features like alternate HUDs or ship viewer into the game.

This table is one of the [[Modular Tables]] and can be extended with xxx-sct.tbm

[[Tables|List of Tables]]

==General Info==
*Scripting table consist of several sections identified by a hash mark preceeding the section name (i.g. #Global Hooks)
*All sections ''must'' end with #'''End'''
*All sections are optional
*Most entries are optional
*Scripting hooks are '''not''' executed on a separate thread (at least as of this writing). They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. Therefore, large and complicated scripts will most likely cause noticeable lag or slowdown when executed.
{{Template:Note|1=Information on this page does not apply to pre-3.6.10 builds}}
 

==Useful references==
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Scripting functions]]'''
*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==Prerequisites==

===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 

===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 

====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 

==Sections==

===#Global Hooks===
Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 

====$Global:====
Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
 

====$Splash:====
This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
 

=====+Override:=====
Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
 

====$GameInit:====
This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
 

====$Simulation:====
This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
 

====$HUD:====
The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
 

=====+Override:=====
Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.
 

===#State Hooks===
In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 

=====$State:=====
Specifies the state name. A full list of states is located here: ''[[List of Game States]]''

=====$Hook:=====
Executed after all of the state code has been executed, but before the game frame is actually drawn.

======+Override:======
Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

===#Conditional Hooks===
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

;Format

;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

====Conditions====

=====$State:=====
Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission.
*The full list of states can be found here: ''[[List of Game States]]''

=====$Campaign:=====
Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).

=====$Mission:=====
Controls execution based on the filename of the last mission to have started. This condition will remain true even after the mission has been exited until another mission is started.

=====$Object Type:=====
Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".

=====$Ship:=====
Defines a specific ship (name) that the action will apply for.

=====$Ship class:=====
Defines a specific ship class (name) that the action will apply for.

=====$Ship type:=====
Defines a specific ship type (name) that the action will apply for.

=====$Weapon class:=====
Defines a specific weapon class (name) that the action will apply for.

=====$KeyPress:=====
Defines a specific key that the action will apply for.
*Experimental.
 

====Actions====

=====$On Game Init:=====
Executes immediately after game has been started.
::* No associated hook variables.

=====$On Splash Screen:=====
Executes when initial game splash screen is shown
::* No associated hook variables.

=====$On State Start:=====
Executed when specified game state starts
::* No associated hook variables.

=====$On Frame:=====
Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.

=====$On Key Pressed:=====
Executed when specified key is pressed
::* '''Key''', The pressed key

=====$On Key Released:=====
Executed when specified key is released
::* '''Key''', The released key

=====$On Mouse Moved:=====
Executed when mouse is moved
::* No associated hook variables.

=====$On Mouse Pressed:=====
Executed when mouse button is pressed
::* No associated hook variables.

=====$On Mouse Released:=====
Executed when mouse button is released
::* No associated hook variables.

=====$On State End:=====
Executed when specified game state ends
::* No associated hook variables.

=====$On Mission Start:=====
Executed when mission starts
::* No associated hook variables.

=====$On Gameplay Start:=====
{{Table3615|
Executed when the gameplay part of a mission starts
::* No associated hook variables.}}

=====$On HUD Draw:=====
Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)

=====$On Ship Collision:=====
Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)

=====$On Weapon Collision:=====
Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)

=====$On Debris Collision:=====
Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)

=====$On Asteroid Collision:=====
Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)

=====$On Object Render:=====
Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)

=====$On Warp In:=====
Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)

=====$On Warp Out:=====
Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)

=====$On Death:=====
*Currently only valid for ships.
Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists

=====$On Mission End:=====
Run on mission end.
::* No associated hook variables.
=====$On Weapon Equipped:=====
{{Table3613|
Runs once each frame, for every ship that has the weapon defined in the $Weapon class condition equipped.
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Fired:=====
{{Table3613|
Runs once when a ship fires a weapon defined in the $Weapon class condition
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Selected:=====
{{Table3613|
Runs once when a bank with a weapon defined in the $Weapon class condition is selected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Weapon Deselected:=====
{{Table3613|
Runs once when a bank with a weapon defined in the $Weapon class condition is deselected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

=====$On Turret Fired:=====
{{Table3615|
Executed when a turret fires
::* '''Ship''', the parent ship
::* '''Weapon''', the weapon which was fired
::* '''Target''', the intended target
}}

=====$On Ship Arrive:=====
{{Table371|
Executed when a a ship arrives
::* '''Ship''', the arriving ship
::* '''Parent''', the ship acting as the anchor when arrival location is "in front of ship", "near ship" or "docking bay"; nil or invalid handle otherwise
}}

==Misc. Hook Variables:==

===Viewer===
*Active if (non-player) viewing object is valid

===Player===
*Active if player obj is valid
 

==Examples==

See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Model Point Shields

2013-11-21T09:04:10Z

Zookeeper: Gave model point shields its own page

Subobject and subsystem properties

2013-11-21T08:56:11Z

Zookeeper: Documented $special=shieldpoint

This page documents the properties that can be applied to subobjects and to subsystems in their respective properties data in the [[Model files|model file]].

==Important notes==
* Subobject/subsystem properties data is not parsed in order.
* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
* Buffer size of 256 is reserved for the characters in properties data.

==Subsystem Properties==
* These can be applied to subsystems both with and without separate subobject.
{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''Key strings and their order for setting subsystems'''''
|-
| align="center"| ''engine''
| Engine subsystem
|-
| align="center"| ''radar''
| Radar dish subsystem
|-
| align="center"| ''turret''
| Turret subsystem
|-
| align="center"| ''navigation''
| Navigation subsystem
|-
| align="center"| ''communication''
| Communication subsystem
|-
| align="center"| ''weapon''
| Weapon control subsystem
|-
| align="center"| ''sensor''
| Sensor subsystem
|-
| align="center"| ''solar''
| Solar panel subsystem
|-
| align="center"| ''gas''
| Gas collector subsystem
|-
| align="center"| ''activator''
| '''''unused'''''
|-
|}

===$name===
*Defines the alternate name for the subsystem (''string'')
*Alternate subsystem names offer an alternative option for setting this via [[ships.tbl]] file or via mission data.

===$fov===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Defines the firing arc of the turret in degrees (''integer'')
*Defaults to 180 degrees if omitted.

===$crewspot===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Marks the turret as 'crewspot'
*Defines the name of the crewspot (''string'')
*No actual function

===$triggered:===
*Defines the subsystem as a rotating subsystem which can be triggered (animated) via [[Animation Code]]

===$rotate===
*Marks the subsystem as a rotating subsystem
*Defines the rotation time for the subsystem (''float'')

====$pbank====
*Marks the rotation as primary weapon rotation
*Defines the associated weapon bank (''integer'')


====$stepped====
*Defines the rotation as an stepped instead of continuous rotation

=====$steps=====
*Defines the number of steps in the animation (''integer'')
*Defaults to 8

=====$t_paused=====
*Defines the pause time between steps (''float'')
*Defaults to 2

=====$t_transit=====
*Defines the movement time between pauses (''float'')
*Defaults to 2

=====$fraction_accel=====
*Defines the fraction of the stepped rotation time used for acceleration (''float'')
*Is between 0 .. 0.5
*Defaults to 0.3

==Subobject Properties==
* These can be applied only to subsystem with their own separate subobject.

===$dumb_rotate:===
* Marks the subobject as 'dumb rotating object'
* Defines the rotation time (''float'')

===$special===
* Defines special attributes for the subobject
* String, either '''"subsystem"''', '''"no_rotate"''' or '''"shieldpoint"'''

===="subsystem"====
* '''subsystem''' marks the subobject as an subsystem

===="no_rotate"====
* Valid option if '''subsystem''' string was not used
* Marks subobject as an object that should not rotate

===="shieldpoint"====
{{Table371|
* Only usable on special points ('''not''' on submodels).
* Marks the special point as a shield point, see [[Model Point Shields]].}}

===$no_collisions===
* Prevents collision detection from occurring on this subobject and all of its children (recursively).

===$nocollide_this_only===
* Prevents collision detection from occurring on this subobject only (children collide normally).

===$collide_invisible===
* Allows full collision detection for things painted with the special "invisible" texture (normally ships collide but weapons do not)

===$gun_rotation:===
* Marks the submodel as using gun rotation

===[[Detail box|$detail_box:]]===
* Marks the subsystem as one with detail box
====[[Detail box|$box_min:]]====
====[[Detail box|$box_max:]]====

===$detail_sphere:===
{{Table3615|
* Marks the subsystem as one with detail sphere. Detail spheres work exactly like detail boxes (see above), except that they only define a radius instead of a box.}}
====$radius:====
{{Table3615|
* Defines the radius of the detail sphere (''float''). If not provided, defaults to the submodel radius.}}
====$offset:====
{{Table3615|
* Optional offset of the detail sphere from the model center.
* Example: '''$offset: 0,0,-100.5''' to make the detail sphere be positioned 100.5m behind the ship's center.}}

===$uvec:===
* Defines the "up" direction (vector) of a multipart turret. Usually it stands perpendicular to the ship surface. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''
* Forces turret normal into the same as the '''$uvec:'''.

===$fvec:===
* Defines the direction of the front a multipart turret will be facing. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''

===$lod0_name===
* Allows adding LODs to older models and changing from special points to modeled subsystems.
* Example $lod0_name=enginea used on a subobject named engine would allow engineb, engienc, and engined to be used while preserving backward compatibility.

===$attach_thrusters===
{{Table3615|
* Allows thrusters associated with this submodel to follow its rotations.}}

[[Category:Modding]]

Ships.tbl

2013-11-21T08:19:57Z

Zookeeper: Documented model point shields

{{TableVersion|10013}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to maximum forward (z) velocity
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to maximum slide velocity
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons and shields recharge.
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds
{{Table3611|
====+Aburn Max Reverse Vel:====
*Defined only for the reverse acceleration, Set the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
====+Aburn Rev accel:====
*Defined only for the reverse acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds'''''}}
====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Game settings.tbl

2013-10-04T18:23:41Z

Zookeeper: Documented $Flight controls follow eyepoint orientation

{{SCP_table}}

{{TableVersion|9771}}

The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally.

This table is one of the [[Modular Tables]] and can be extended with xxx-mod.tbm

[[Tables|List of Tables]]

==#CAMPAIGN SETTINGS==
Optional. This group contains various Campaign related settings and overrides. 

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String''''' 

==#Ignored Campaign File Names==
Optional. Defines which campaigns, if present, will not appear in the Campaign Room. Only single-player campaigns can be ignored. ''File extensions are required.''
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}

===$Campaign File Name:===
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String''''' 

==#HUD SETTINGS==
Optional. This group contains various HUD behavior settings and overrides 

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer''''' 
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

==#SEXP SETTINGS==
Optional. This group contains SEXP settings and overrides. 

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

==#GRAPHICS SETTINGS==
Optional. This group contains settings related to graphics. 

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high) }}

==#OTHER SETTINGS==
Optional. This group contains miscellaneous settings. 

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default ship select effect:===
{{Table3615|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS2", "FS1", and "off"}}

===$Default weapon select effect:===
{{Table3615|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS2", "FS1", and "off"}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting. Default is false.}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship. Default is false.}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

Ships.tbl

2013-09-17T12:43:21Z

Zookeeper: Forgot to document +Spread From LOD

{{TableVersion|9058}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to maximum forward (z) velocity
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to maximum slide velocity
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons and shields recharge.
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds
{{Table3611|
====+Aburn Max Reverse Vel:====
*Defined only for the reverse acceleration, Set the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
====+Aburn Rev accel:====
*Defined only for the reverse acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds'''''}}
====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|+.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2013-09-17T12:28:52Z

Zookeeper: Documented auto spread shields

{{TableVersion|9058}}

The '''ships.tbl''' defines all the ship classes used in FSO.

This table is one of the [[Modular Tables]] and can be extended with xxx-shp.tbm

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to maximum forward (z) velocity
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to maximum slide velocity
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axiis
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Allow Bypass:====
{{Table371|
*Determines whether shots which impact the ship's hull before they've travelled at least a distance equal to the shield thickness will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean''''',.
**Default: ''NO''}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons and shields recharge.
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds
{{Table3611|
====+Aburn Max Reverse Vel:====
*Defined only for the reverse acceleration, Set the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
====+Aburn Rev accel:====
*Defined only for the reverse acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds'''''}}
====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|+.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Game settings.tbl

2012-11-14T13:46:03Z

Zookeeper: Documented $Default Detail Level

{{SCP_table}}

{{TableVersion|9089}}

The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally.

This table is one of the [[Modular Tables]] and can be extended with xxx-mod.tbm

[[Tables|List of Tables]]

==#CAMPAIGN SETTINGS==
Optional. This group contains various Campaign related settings and overrides. 

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String''''' 

==#HUD Settings==
Optional. This group contains various HUD behavior settings and overrides 

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer''''' 
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene Camera Disables HUD:===
Switches off the HUD when the cutscene camera is enabled. This option is on by default.
*Syntax: '''''Boolean''''' 
*Default Value: '''''YES'''''

==#SEXP SETTINGS==
Optional. This group contains SEXP settings and overrides. 

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

==#GRAPHICS SETTINGS==
Optional. This group contains settings related to graphics. 

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high) }}

==#OTHER SETTINGS==
Optional. This group contains miscellaneous settings. 

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default ship select effect:===
{{Table3615|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}

===$Default weapon select effect:===
{{Table3615|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting. Default is false.}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

Controlconfigdefaults.tbl

2012-08-25T21:22:52Z

Zookeeper: Fixed a few typoed keybind names

{{TableVersion|7478}}

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

[[Tables|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.

==$Bind Name:==
*Name of the bind or action to modify the default key of.
*Valid entries: [[Controlconfigdefaults.tbl#List of Bindings|List of Bindings]]
*Required
*Syntax: '''String'''
===$Key Default:===
*Key to set as default
*Valid entries: [[Controlconfigdefaults.tbl#Allowed Keys|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
*Syntax: '''String'''
===$Has XStr:===
*Whether or not the binding has an entry in [[tstrings.tbl]]
*'''1''' for yes, '''0''' for no
*Optional
*Syntax: '''Integer'''
===$Type:===
*Whether or not the binding needs a continuous press of the key?
*Valid entries: CC_TYPE_TRIGGER, CC_TYPE_CONTINUOUS
*Optional
*Syntax '''String'''

==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

<pre>
#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
</pre>

==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'

[[Category:Tables]]

Hud gauges.tbl

2012-08-15T19:37:54Z

Zookeeper: Documented change of $Comms Menu Hides Messages to a +Messages gauge flag

{{SCP table}}

{{TableVersion|9018}}

The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

This table is one of the [[Modular Tables]] and can be extended with xxx-hdg.tbm

[[Tables|List of Tables]]

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Sytax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD.

*Syntax: '''Integer''' font index number
*Valid Values: Any font index as defined in [[Fonts.tbl]]

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Optional. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

===$Base:===
Defines the base resolution for this HUD configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3)
:"Wide Screen" (16:9, 16:10, or similar)

===$Min:===
Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X-Offset|X-Offset:]] (Optional)
:[[Hud_gauges.tbl#Y-Offset|Y-Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)
:[[Hud_gauges.tbl#Hidden By Comms Menu:|Hidden By Comms Menu:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Optional)

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:Page Up Offsets]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:Page Down Offsets]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing. SVN 8830

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar.

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)

====+Text Warnings:====
Adds a gauge that warns the player (of something).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that is used to raise the probability of hitting a target with primary weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 12

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the file used for this gauge's the background graphic

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Background Filename:====
Optional. Designates which file to use for the Entry background

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
*Units: Pixels

{{Warning|
All 5 wingman positions must be defined}}

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge

*Syntax: '''String'''
*Valid Values:
:*"Right" ;; Wings are added to the right of the previous wing

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Optional. Defines the size of the animation's background (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Cockpit Target:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Canvas Size:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Display Offset:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Display Size:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Afterburner Energy:|+Afterburner Energy:]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for the primary single fire-mode.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Hidden By Comms Menu:====
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
{{Table3615|
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
}}

[[Category:Tables]]

Hud gauges.tbl

2012-08-15T15:07:32Z

Zookeeper: Documented $Comms Menu Hides Messages:

{{SCP table}}

{{TableVersion|9018}}

The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

This table is one of the [[Modular Tables]] and can be extended with xxx-hdg.tbm

[[Tables|List of Tables]]

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Sytax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD.

*Syntax: '''Integer''' font index number
*Valid Values: Any font index as defined in [[Fonts.tbl]]

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

===$Comms Menu Hides Messages:===
{{Table3615|
Optional. Defines whether the wingman comms menu and regular messages may be drawn at the same time.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
}}

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Optional. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

===$Base:===
Defines the base resolution for this HUD configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3)
:"Wide Screen" (16:9, 16:10, or similar)

===$Min:===
Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X-Offset|X-Offset:]] (Optional)
:[[Hud_gauges.tbl#Y-Offset|Y-Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Optional)

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:Page Up Offsets]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:Page Down Offsets]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing. SVN 8830

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar.

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)

====+Text Warnings:====
Adds a gauge that warns the player (of something).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that is used to raise the probability of hitting a target with primary weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 12

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the file used for this gauge's the background graphic

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Background Filename:====
Optional. Designates which file to use for the Entry background

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
*Units: Pixels

{{Warning|
All 5 wingman positions must be defined}}

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge

*Syntax: '''String'''
*Valid Values:
:*"Right" ;; Wings are added to the right of the previous wing

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Optional. Defines the size of the animation's background (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Cockpit Target:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Canvas Size:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Display Offset:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

=====Display Size:=====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Afterburner Energy:|+Afterburner Energy:]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for the primary single fire-mode.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

[[Category:Tables]]

Subobject and subsystem properties

2012-05-18T15:30:29Z

Zookeeper: Documented detail sphere $offset

This page documents the properties that can be applied to subobjects and to subsystems in their respective properties data in the [[Model files|model file]].

==Important notes==
* Subobject/subsystem properties data is not parsed in order.
* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
* Buffer size of 256 is reserved for the characters in properties data.

==Subsystem Properties==
* These can be applied to subsystems both with and without separate subobject.
{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''Key strings and their order for setting subsystems'''''
|-
| align="center"| ''engine''
| Engine subsystem
|-
| align="center"| ''radar''
| Radar dish subsystem
|-
| align="center"| ''turret''
| Turret subsystem
|-
| align="center"| ''navigation''
| Navigation subsystem
|-
| align="center"| ''communication''
| Communication subsystem
|-
| align="center"| ''weapon''
| Weapon control subsystem
|-
| align="center"| ''sensor''
| Sensor subsystem
|-
| align="center"| ''solar''
| Solar panel subsystem
|-
| align="center"| ''gas''
| Gas collector subsystem
|-
| align="center"| ''activator''
| '''''unused'''''
|-
|}

===$name===
*Defines the alternate name for the subsystem (''string'')
*Alternate subsystem names offer an alternative option for setting this via [[ships.tbl]] file or via mission data.

===$fov===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Defines the firing arc of the turret in degrees (''integer'')
*Defaults to 180 degrees if omitted.

===$crewspot===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Marks the turret as 'crewspot'
*Defines the name of the crewspot (''string'')
*No actual function

===$triggered:===
*Defines the subsystem as a rotating subsystem which can be triggered (animated) via [[Animation Code]]

===$rotate===
*Marks the subsystem as a rotating subsystem
*Defines the rotation time for the subsystem (''float'')

====$pbank====
*Marks the rotation as primary weapon rotation
*Defines the associated weapon bank (''integer'')


====$stepped====
*Defines the rotation as an stepped instead of continuous rotation

=====$steps=====
*Defines the number of steps in the animation (''integer'')
*Defaults to 8

=====$t_paused=====
*Defines the pause time between steps (''float'')
*Defaults to 2

=====$t_transit=====
*Defines the movement time between pauses (''float'')
*Defaults to 2

=====$fraction_accel=====
*Defines the fraction of the stepped rotation time used for acceleration (''float'')
*Is between 0 .. 0.5
*Defaults to 0.3

==Subobject Properties==
* These can be applied only to subsystem with their own separate subobject.

===$dumb_rotate:===
* Marks the subobject as 'dumb rotating object'
* Defines the rotation time (''float'')

===$special===
* Defines special attributes for the subobject
* String, either '''"subsystem"''' or '''"no_rotate"'''

===="subsystem"====
* '''subsystem''' marks the subobject as an subsystem

===="no_rotate"====
* Valid option if '''subsystem''' string was not used
* Marks subobject as an object that should not rotate

===$no_collisions===
* Prevents collision detection from occurring on this subobject and all of its children (recursively).

===$nocollide_this_only===
* Prevents collision detection from occurring on this subobject only (children collide normally).

===$collide_invisible===
* Allows full collision detection for things painted with the special "invisible" texture (normally ships collide but weapons do not)

===$gun_rotation:===
* Marks the submodel as using gun rotation

===[[Detail box|$detail_box:]]===
* Marks the subsystem as one with detail box
====[[Detail box|$box_min:]]====
====[[Detail box|$box_max:]]====

===$detail_sphere:===
{{Table3615|
* Marks the subsystem as one with detail sphere. Detail spheres work exactly like detail boxes (see above), except that they only define a radius instead of a box.}}
====$radius:====
{{Table3615|
* Defines the radius of the detail sphere (''float''). If not provided, defaults to the submodel radius.}}
====$offset:====
{{Table3615|
* Optional offset of the detail sphere from the model center.
* Example: '''$offset: 0,0,-100.5''' to make the detail sphere be positioned 100.5m behind the ship's center.}}

===$uvec:===
* Defines the "up" direction (vector) of a multipart turret. Usually it stands perpendicular to the ship surface. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''
* Forces turret normal into the same as the '''$uvec:'''.

===$fvec:===
* Defines the direction of the front a multipart turret will be facing. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''

===$lod0_name===
* Allows adding LODs to older models and changing from special points to modeled subsystems.
* Example $lod0_name=enginea used on a subobject named engine would allow engineb, engienc, and engined to be used while preserving backward compatibility.

===$attach_thrusters===
{{Table3615|
* Allows thrusters associated with this submodel to follow its rotations.}}

[[Category:Modding]]

Game settings.tbl

2012-03-22T06:21:37Z

Zookeeper:

{{TableVersion|8586}}

*The game_settings.tbl file defines options that can be changed globally.

==Campaign Settings==
Begins with #CAMPAIGN SETTINGS

===$Default Campaign File Name:===
*Defines which campaign will be selected by default for new pilots.
*Do not include the file extension.
*Syntax: '''''String'''''

==HUD Settings==
Begins with #HUD SETTINGS

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*In milliseconds.
*Syntax: '''''Integer'''''

==SEXP Settings==
Begins with #SEXP SETTINGS

===$Loop SEXPs Then Arguments:===
*Flips how when-argument settings loop. See this post. http://www.hard-light.net/forums/index.php?topic=79602.0
*Syntax: '''''Boolean'''''

==Other Settings==
Begins with #OTHER SETTINGS

===$Self Praise Percentage:===
*Sets the percent chance a message will play where a pilot praises his own kills.
*Number between 0 - 100.
*Syntax: '''''Integer'''''

===$Fixed Turret Collisions:===
*Makes all hits to a turret's barrels count as hits to the turret subsystem. By default this does not happen, unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''

===$Damage Impacted Subsystem First:===
*If set, a hit which impacts a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''

==END==
Table must end with #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

Subsystem

2012-03-17T18:47:08Z

Zookeeper: Documented the "collide submodel" flag

{{Fileversion|7119}}

*All subsystems ship can have must be defined in ships model file (.pof).

{{Table3610|
*[[Animation_Code|Animation Code]] can be applied to the subsystems that consist of submodels, like multi-part turrets.}}

==$Subsystem:==
*The name of the subsystem as defined in .pof file, % of ship's total hitpoints the subsystem has and rotation time (360 degrees) for multi-part turrets. Note: Assinging zero to the %-hitpoint entry causes the subsystem to be without hitpoints, like fighterbays on some capital ships.
*Syntax: '''''String''''', '''''Float''''', '''''Float''''', name of the subsystem followed by the subsystem hitpoints as % of ships hitpoints and seconds per 360 degree turn. Subsystem name must be the same as described in model file (.pof).
{{Table3610|
*Entries can be left empty in which case game uses default values}}
**Example: communications, 5, 0.0

===$Alt Subsystem Name:===
{{Table3610|
*Defines the alternate name for the subsystem. This name is shown for example in the targeting window when subsystem is targeted.
*Syntax: '''''String'''''}}
{{Table3611|
*Option to use pipe character '<nowiki>|</nowiki>' to force line breaks into the alt subsystem name}}

===$Alt Damage Popup Subsystem Name:===
{{Table3611|
*Defines the alternate name for the subsystem when it is displayed on the '''damaged systems''' popup.
*Syntax: '''''String'''''}}

===$Armor Type:===
{{Table3610|
* '''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the subsystem. If subsystem armor type is not defined ships armor type is used instead.
* Syntax: '''''String''''', as defined in [[armor.tbl]]}}

===$Default PBanks:===
*Defines default primary weapon for the turret
*Syntax: ( '''''"String"''''' )
**Example: ( ''"Subach HL-7"'' )

===$PBank Capacity:===
{{Table3610|
*Defines ammunition capacity of turrets ballistic primary weapon.
*Syntax: ( '''''Integer''''' )}}

===$Default SBanks:===
*Defines default secondary weapon for the turret
*Syntax: ( '''''"String"''''' )

===$SBank Capacity:===
*Defines ammunition capacity of turrets secondary weapon.
*Syntax: ( '''''Integer''''' )

===$Engine Wash:===
*All engines may use information concerning the engine wash. Engine washes are usually used only with larger vessels.
*Syntax: '''''String''''', name as defined in Engine Wash section in [[ships.tbl]]
**Example: ''Default1000''

===$AliveSnd:===
{{Table3610|
*Specifies a sound to play from the subsystem while it is not destroyed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$DeadSnd:===
{{Table3610|
*Specifies a sound to play from the subsystem while it is destroyed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$RotationSnd:===
{{Table3613|
*Can be used to define a sound that is played when this subsystem rotates.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret Base RotationSnd:===
{{Table3611|
*Defines the sound which is played when the turrets base rotates
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret Gun RotationSnd:===
{{Table3611|
*Defines the sound which is played when the turrets guns change their elevation
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret BaseSnd Volume:===
{{Table3611|
*Defines the multiplier for the sound volume for turret base rotations
*Syntax: '''''Float'''''}}

===$Turret GunSnd Volume:===
{{Table3611|
*Defines the multiplier for the sound volume for turret guns change their elevation
*Syntax: '''''Float'''''}}

===$AWACS:===
*Sets this subsystem's effective AWACS range. (AWACS reveals stealthed ships, cuts through nebula fog.)
*Syntax: '''''Float''''', the maximum range of the AWACS

===$Maximum Barrel Elevation:===
{{Table3611|
*Defines the maximum barrel elevation for the turret
*Basically 'inverse FOV'.
*Syntax: '''''Integer''''', from 0 to 90}}

===$Turret Base FOV:===
{{Table3611|
*Defines the FOV of the turret's base.
*Syntax: '''''Integer''''', from 0 to 359}}

===$Turret Reset Delay:===
{{Table3611|
*Defines the time after losing the target before the turret begins to reset itself
*Syntax: '''''Integer''''', in milliseconds}}

===$Turret Optimum Range:===
{{Table3611|
*Defines the optimum range for the turret
*Syntax: '''''Float'''''}}

===$Turret Direction Preference:===
{{Table3611|
*Defines the turrets preference to keep targeting targets based how far the turret should turn instead of nearest target
*The higher the value the higher the preference to keep targeting targets close to previous targets direction
*Syntax: '''''Integer''''', from 0 to 100, 0 disables the preference setup}}

===$Target Priority:===
{{Table3611|
*Defines the target priorities, and their order for the turret
*Syntax: '''''String list'''''}}

===$Max Turrets per Bomb:===
{{Table3613|
*Limits the number of turrets that can be targeting the same bomb.
*When this is set, when this turret tries to target a bomb, it will check to see how many turrets are already targeting it and only choose it as a target if there are less than this number.
*This allows control over the default behavior, where every turret will fire at the leading bomb.
*Syntax: '''''Integer'''''}}

===$Max Turrets per Target:===
{{Table3613|
*Limits the number of turrets that can be targeting the same target.
*When this is set, when this turret tries to target a ship, it will check to see how many turrets are already targeting it and only choose it as a target if there are less than this number.
*This helps turrets spread their efforts out among multiple targets.
*Syntax: '''''Integer'''''}}

===$ROF:===
{{Table3613|
*Defines the modifier applied to the turret rate of fire (ROF).

====+Use firingpoints====
*Modifies (multiplies) the rate of fire by the number of firingpoints the turret has.

====+Multiplier:====
*Checked only if ''+Use firingpoints'' has not been defined
*If set to larger than 0 the value acts as multiplier
*If set to 1.0 the feature is disabled
*If set to equal to or smaller than 0 it as if ''+Use firingpoints'' option would have been enabled
*Syntax: '''''Float'''''}}

===$Flags:===
{{Table3610|
*Can be used to sets additional subsystem related properties
*Syntax: ( '''''"String" "String"''''' )
*List of available flags:

===="untargetable"====
*Subsystem cannot be targeted

===="carry no damage"====
*Damage caused to the subsystem will not carry over to the parent ship

===="use multiple guns"====
*Enables the turret to fire all equipped weapons, picking a not-in-use firing point at each trigger. Not to be confused with 'Salvo mode'.

===="fire down normals"====
*Forces the turret to fire along the turret normals - regardless of the swarm setting.

===="check hull"====
*Forces the firing turret to check against the parent model if valid line of sight exists between the firingpoint and the target.}}

{{Table3611|
===="fixed firingpoints"====
*Forces the firing turret to retain the firingpoints of their weapons: if the turret has multiple banks, the first bank will only fire from the first firepoint, the second bank only from the second firepoint, and so on. Maximum number of weapons is the same as maximum number of weapons in turret (3 primary, 4 secondary)

===="salvo mode"====
*Forces the firing turret to use only the first weapon defined for it but fires it simultaneously from all the firing points. Not to be confused with 'use multiple guns'

===="no subsystem targeting"====
*Prevents the firing turret from targeting targets subsystems - instead forces the turret to fire randomly at the targets hull.

===="fire on target"====
*Prevents the turret from firing unless the turret barrels (firingpoints) and targets are aligned.

===="reset when idle"====
*Forces the turret to reset to its initial position if it has no targets.

===="carry shockwave"====
*Forces the turret to carry damage caused by shockwaves to the hull regardless of other flags.}}

{{Table3613|
===="allow landing"====
*Defines the subsystem as something on which player can attempt to land on

===="target requires fov"====
*Prevents turret from accidentally selecting target out of it field of view (fov) when acquiring targets

===="fov edge checks"====
*If the predicted target point of the turret falls outside of the field of view this flag but according to ship radius and dot product the target should still be partially visible then this flag attempts to turn the turret to the edge of the FOV closest to the targeted position and allow it to fire along that direction.

===="no replace"====
*Tells game not to use the replacement submodel (-destroyed) when the subsystem loses all of it's hitpoints.

===="no live debris"====
*Prevents the subsystem from releasing live debris pieces when destroyed

===="ignore if dead"====
*When subsystem has been destroyed prevents homing weapons from attempting to hit the now destroyed submodel and instead tells them to home on the main hull of the target

===="allow vanishing"====
*Allow subsystem to be destroyed from the ship without sound or graphical effects

===="damage as hull"====
*Treats subsystem as if it were hull when applying damage.

===="starts locked"====
*Turret starts locked and won't shoot until you use a turret-free or turret-free-all SEXP on it.

===="no aggregate"====
*Freespace keeps track of a ships overall functionality (such as if a ship is sensorless, disarmed or disabled) via a total hitpoint count of the associated subsystems. For example if a ship has three engines with 100HP each, the 'engines' count will be at 300HP. Shooting at any of the subsystems with the keyword 'engine' in them will decrement this total, and when it is at 0 then the ship becomes disabled.
*This flag tells FS to ignore the associated subsystem and not count it towards those totals. For example, if a ship had three 100HP engines with one set to 'no aggregate' then the 'engines' count will be 200HP. Shooting the 'no aggregate' engine will not decrement the 'engines' count, and so in other words the status of this engine is irrelevant to whether or not the ship is disabled. In the same way when applied to a turret, the turret's status is irrelevant to whether the ship is disarmed or not.

===="wait for animation"====
*When this flag is active, a turret will only fire after any associated subsystem animations (such as a turret hatch opening) have played out.

===="play fire sound for player"====
*If this turret is on a player ship, play its associated sounds.

===="only target if can fire"====
*Do additional checks to make sure that a turret which cannot fire at its target releases that target.
}}

{{Table3615|
===="no disappear"====
*If this subsystem is a physical subsystem, it won't disappear nor switch to the -destroyed model when destroyed.
}}

{{Table3615|
===="collide submodel"====
*If this subsystem is a physical subsystem, it will only take damage from hits which impact the submodel. By default damage is taken from all hits within the submodel's radius*2. Does not affect area damage such as shockwaves.
}}

===[[Animation Code]]===
{{Table3610|
*Option for animating the submodels}}

==Case Specific Entries==

===Turret===
*All turrets require information concerning the weapon mounted to the turret. The entry can be either '''$Default PBanks''' for turret primaries (including beams) or '''$Default SBanks''' for turret secondaries
{{Table3610|
*[[Animation_Code#Setting_Turret_Angle|Animation Code]] can be used with multi-part turrets.
*Multiple defined weapons will all fire but the targeting is handled by the first weapon in the list. '''Multiple beams are not possible'''. All weapons alternate between the firingpoints of the turret so turrets do not need to have more than one weapon defined no matter how many barrels or firingpoints they have.}}

====Example====

<pre>
$Subsystem: turret01, 1.0, 1.0
$Default PBanks: ( "Terran Turret" )
</pre>

===Engine===

====Example====

<pre>
$Subsystem: engine01, 5.0, 0.0
$Engine Wash: Default1000
</pre>

[[Category:Tables]]

Subsystem

2012-03-15T13:29:13Z

Zookeeper: Documented the "no disappear" subsystem flag

{{Fileversion|7119}}

*All subsystems ship can have must be defined in ships model file (.pof).

{{Table3610|
*[[Animation_Code|Animation Code]] can be applied to the subsystems that consist of submodels, like multi-part turrets.}}

==$Subsystem:==
*The name of the subsystem as defined in .pof file, % of ship's total hitpoints the subsystem has and rotation time (360 degrees) for multi-part turrets. Note: Assinging zero to the %-hitpoint entry causes the subsystem to be without hitpoints, like fighterbays on some capital ships.
*Syntax: '''''String''''', '''''Float''''', '''''Float''''', name of the subsystem followed by the subsystem hitpoints as % of ships hitpoints and seconds per 360 degree turn. Subsystem name must be the same as described in model file (.pof).
{{Table3610|
*Entries can be left empty in which case game uses default values}}
**Example: communications, 5, 0.0

===$Alt Subsystem Name:===
{{Table3610|
*Defines the alternate name for the subsystem. This name is shown for example in the targeting window when subsystem is targeted.
*Syntax: '''''String'''''}}
{{Table3611|
*Option to use pipe character '<nowiki>|</nowiki>' to force line breaks into the alt subsystem name}}

===$Alt Damage Popup Subsystem Name:===
{{Table3611|
*Defines the alternate name for the subsystem when it is displayed on the '''damaged systems''' popup.
*Syntax: '''''String'''''}}

===$Armor Type:===
{{Table3610|
* '''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the subsystem. If subsystem armor type is not defined ships armor type is used instead.
* Syntax: '''''String''''', as defined in [[armor.tbl]]}}

===$Default PBanks:===
*Defines default primary weapon for the turret
*Syntax: ( '''''"String"''''' )
**Example: ( ''"Subach HL-7"'' )

===$PBank Capacity:===
{{Table3610|
*Defines ammunition capacity of turrets ballistic primary weapon.
*Syntax: ( '''''Integer''''' )}}

===$Default SBanks:===
*Defines default secondary weapon for the turret
*Syntax: ( '''''"String"''''' )

===$SBank Capacity:===
*Defines ammunition capacity of turrets secondary weapon.
*Syntax: ( '''''Integer''''' )

===$Engine Wash:===
*All engines may use information concerning the engine wash. Engine washes are usually used only with larger vessels.
*Syntax: '''''String''''', name as defined in Engine Wash section in [[ships.tbl]]
**Example: ''Default1000''

===$AliveSnd:===
{{Table3610|
*Specifies a sound to play from the subsystem while it is not destroyed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$DeadSnd:===
{{Table3610|
*Specifies a sound to play from the subsystem while it is destroyed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$RotationSnd:===
{{Table3613|
*Can be used to define a sound that is played when this subsystem rotates.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret Base RotationSnd:===
{{Table3611|
*Defines the sound which is played when the turrets base rotates
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret Gun RotationSnd:===
{{Table3611|
*Defines the sound which is played when the turrets guns change their elevation
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Turret BaseSnd Volume:===
{{Table3611|
*Defines the multiplier for the sound volume for turret base rotations
*Syntax: '''''Float'''''}}

===$Turret GunSnd Volume:===
{{Table3611|
*Defines the multiplier for the sound volume for turret guns change their elevation
*Syntax: '''''Float'''''}}

===$AWACS:===
*Sets this subsystem's effective AWACS range. (AWACS reveals stealthed ships, cuts through nebula fog.)
*Syntax: '''''Float''''', the maximum range of the AWACS

===$Maximum Barrel Elevation:===
{{Table3611|
*Defines the maximum barrel elevation for the turret
*Basically 'inverse FOV'.
*Syntax: '''''Integer''''', from 0 to 90}}

===$Turret Base FOV:===
{{Table3611|
*Defines the FOV of the turret's base.
*Syntax: '''''Integer''''', from 0 to 359}}

===$Turret Reset Delay:===
{{Table3611|
*Defines the time after losing the target before the turret begins to reset itself
*Syntax: '''''Integer''''', in milliseconds}}

===$Turret Optimum Range:===
{{Table3611|
*Defines the optimum range for the turret
*Syntax: '''''Float'''''}}

===$Turret Direction Preference:===
{{Table3611|
*Defines the turrets preference to keep targeting targets based how far the turret should turn instead of nearest target
*The higher the value the higher the preference to keep targeting targets close to previous targets direction
*Syntax: '''''Integer''''', from 0 to 100, 0 disables the preference setup}}

===$Target Priority:===
{{Table3611|
*Defines the target priorities, and their order for the turret
*Syntax: '''''String list'''''}}

===$Max Turrets per Bomb:===
{{Table3613|
*Limits the number of turrets that can be targeting the same bomb.
*When this is set, when this turret tries to target a bomb, it will check to see how many turrets are already targeting it and only choose it as a target if there are less than this number.
*This allows control over the default behavior, where every turret will fire at the leading bomb.
*Syntax: '''''Integer'''''}}

===$Max Turrets per Target:===
{{Table3613|
*Limits the number of turrets that can be targeting the same target.
*When this is set, when this turret tries to target a ship, it will check to see how many turrets are already targeting it and only choose it as a target if there are less than this number.
*This helps turrets spread their efforts out among multiple targets.
*Syntax: '''''Integer'''''}}

===$ROF:===
{{Table3613|
*Defines the modifier applied to the turret rate of fire (ROF).

====+Use firingpoints====
*Modifies (multiplies) the rate of fire by the number of firingpoints the turret has.

====+Multiplier:====
*Checked only if ''+Use firingpoints'' has not been defined
*If set to larger than 0 the value acts as multiplier
*If set to 1.0 the feature is disabled
*If set to equal to or smaller than 0 it as if ''+Use firingpoints'' option would have been enabled
*Syntax: '''''Float'''''}}

===$Flags:===
{{Table3610|
*Can be used to sets additional subsystem related properties
*Syntax: ( '''''"String" "String"''''' )
*List of available flags:

===="untargetable"====
*Subsystem cannot be targeted

===="carry no damage"====
*Damage caused to the subsystem will not carry over to the parent ship

===="use multiple guns"====
*Enables the turret to fire all equipped weapons, picking a not-in-use firing point at each trigger. Not to be confused with 'Salvo mode'.

===="fire down normals"====
*Forces the turret to fire along the turret normals - regardless of the swarm setting.

===="check hull"====
*Forces the firing turret to check against the parent model if valid line of sight exists between the firingpoint and the target.}}

{{Table3611|
===="fixed firingpoints"====
*Forces the firing turret to retain the firingpoints of their weapons: if the turret has multiple banks, the first bank will only fire from the first firepoint, the second bank only from the second firepoint, and so on. Maximum number of weapons is the same as maximum number of weapons in turret (3 primary, 4 secondary)

===="salvo mode"====
*Forces the firing turret to use only the first weapon defined for it but fires it simultaneously from all the firing points. Not to be confused with 'use multiple guns'

===="no subsystem targeting"====
*Prevents the firing turret from targeting targets subsystems - instead forces the turret to fire randomly at the targets hull.

===="fire on target"====
*Prevents the turret from firing unless the turret barrels (firingpoints) and targets are aligned.

===="reset when idle"====
*Forces the turret to reset to its initial position if it has no targets.

===="carry shockwave"====
*Forces the turret to carry damage caused by shockwaves to the hull regardless of other flags.}}

{{Table3613|
===="allow landing"====
*Defines the subsystem as something on which player can attempt to land on

===="target requires fov"====
*Prevents turret from accidentally selecting target out of it field of view (fov) when acquiring targets

===="fov edge checks"====
*If the predicted target point of the turret falls outside of the field of view this flag but according to ship radius and dot product the target should still be partially visible then this flag attempts to turn the turret to the edge of the FOV closest to the targeted position and allow it to fire along that direction.

===="no replace"====
*Tells game not to use the replacement submodel (-destroyed) when the subsystem loses all of it's hitpoints.

===="no live debris"====
*Prevents the subsystem from releasing live debris pieces when destroyed

===="ignore if dead"====
*When subsystem has been destroyed prevents homing weapons from attempting to hit the now destroyed submodel and instead tells them to home on the main hull of the target

===="allow vanishing"====
*Allow subsystem to be destroyed from the ship without sound or graphical effects

===="damage as hull"====
*Treats subsystem as if it were hull when applying damage.

===="starts locked"====
*Turret starts locked and won't shoot until you use a turret-free or turret-free-all SEXP on it.

===="no aggregate"====
*Freespace keeps track of a ships overall functionality (such as if a ship is sensorless, disarmed or disabled) via a total hitpoint count of the associated subsystems. For example if a ship has three engines with 100HP each, the 'engines' count will be at 300HP. Shooting at any of the subsystems with the keyword 'engine' in them will decrement this total, and when it is at 0 then the ship becomes disabled.
*This flag tells FS to ignore the associated subsystem and not count it towards those totals. For example, if a ship had three 100HP engines with one set to 'no aggregate' then the 'engines' count will be 200HP. Shooting the 'no aggregate' engine will not decrement the 'engines' count, and so in other words the status of this engine is irrelevant to whether or not the ship is disabled. In the same way when applied to a turret, the turret's status is irrelevant to whether the ship is disarmed or not.

===="wait for animation"====
*When this flag is active, a turret will only fire after any associated subsystem animations (such as a turret hatch opening) have played out.

===="play fire sound for player"====
*If this turret is on a player ship, play its associated sounds.

===="only target if can fire"====
*Do additional checks to make sure that a turret which cannot fire at its target releases that target.
}}

{{Table3615|
===="no disappear"====
*If this subsystem is a physical subsystem, it won't disappear nor switch to the -destroyed model when destroyed.
}}

===[[Animation Code]]===
{{Table3610|
*Option for animating the submodels}}

==Case Specific Entries==

===Turret===
*All turrets require information concerning the weapon mounted to the turret. The entry can be either '''$Default PBanks''' for turret primaries (including beams) or '''$Default SBanks''' for turret secondaries
{{Table3610|
*[[Animation_Code#Setting_Turret_Angle|Animation Code]] can be used with multi-part turrets.
*Multiple defined weapons will all fire but the targeting is handled by the first weapon in the list. '''Multiple beams are not possible'''. All weapons alternate between the firingpoints of the turret so turrets do not need to have more than one weapon defined no matter how many barrels or firingpoints they have.}}

====Example====

<pre>
$Subsystem: turret01, 1.0, 1.0
$Default PBanks: ( "Terran Turret" )
</pre>

===Engine===

====Example====

<pre>
$Subsystem: engine01, 5.0, 0.0
$Engine Wash: Default1000
</pre>

[[Category:Tables]]

Subobject and subsystem properties

2012-01-26T15:02:44Z

Zookeeper: Documented $detail_sphere

This page documents the properties that can be applied to subobjects and to subsystems in their respective properties data in the [[Model files|model file]].

==Important notes==
* Subobject/subsystem properties data is not parsed in order.
* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
* Buffer size of 256 is reserved for the characters in properties data.

==Subsystem Properties==
* These can be applied to subsystems both with and without separate subobject.
{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''Key strings and their order for setting subsystems'''''
|-
| align="center"| ''engine''
| Engine subsystem
|-
| align="center"| ''radar''
| Radar dish subsystem
|-
| align="center"| ''turret''
| Turret subsystem
|-
| align="center"| ''navigation''
| Navigation subsystem
|-
| align="center"| ''communication''
| Communication subsystem
|-
| align="center"| ''weapon''
| Weapon control subsystem
|-
| align="center"| ''sensor''
| Sensor subsystem
|-
| align="center"| ''solar''
| Solar panel subsystem
|-
| align="center"| ''gas''
| Gas collector subsystem
|-
| align="center"| ''activator''
| '''''unused'''''
|-
|}

===$name===
*Defines the alternate name for the subsystem (''string'')
*Alternate subsystem names offer an alternative option for setting this via [[ships.tbl]] file or via mission data.

===$fov===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Defines the firing arc of the turret in degrees (''integer'')
*Defaults to 180 degrees if omitted.

===$crewspot===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Marks the turret as 'crewspot'
*Defines the name of the crewspot (''string'')
*No actual function

===$triggered:===
*Defines the subsystem as a rotating subsystem which can be triggered (animated) via [[Animation Code]]

===$rotate===
*Marks the subsystem as a rotating subsystem
*Defines the rotation time for the subsystem (''float'')

====$pbank====
*Marks the rotation as primary weapon rotation
*Defines the associated weapon bank (''integer'')


====$stepped====
*Defines the rotation as an stepped instead of continuous rotation

=====$steps=====
*Defines the number of steps in the animation (''integer'')
*Defaults to 8

=====$t_paused=====
*Defines the pause time between steps (''float'')
*Defaults to 2

=====$t_transit=====
*Defines the movement time between pauses (''float'')
*Defaults to 2

=====$fraction_accel=====
*Defines the fraction of the stepped rotation time used for acceleration (''float'')
*Is between 0 .. 0.5
*Defaults to 0.3

==Subobject Properties==
* These can be applied only to subsystem with their own separate subobject.

===$dumb_rotate:===
* Marks the subobject as 'dumb rotating object'
* Defines the rotation time (''float'')

===$special===
* Defines special attributes for the subobject
* String, either '''"subsystem"''' or '''"no_rotate"'''

===="subsystem"====
* '''subsystem''' marks the subobject as an subsystem

===="no_rotate"====
* Valid option if '''subsystem''' string was not used
* Marks subobject as an object that should not rotate

===$no_collisions===
* Prevents collision detection from occurring on this subobject and all of its children (recursively).

===$nocollide_this_only===
* Prevents collision detection from occurring on this subobject only (children collide normally).

===$collide_invisible===
* Allows full collision detection for things painted with the special "invisible" texture (normally ships collide but weapons do not)

===$gun_rotation:===
* Marks the submodel as using gun rotation

===[[Detail box|$detail_box:]]===
* Marks the subsystem as one with detail box
====[[Detail box|$box_min:]]====
====[[Detail box|$box_max:]]====

===$detail_sphere:===
{{Table3615|
* Marks the subsystem as one with detail sphere. Detail spheres work exactly like detail boxes (see above), except that they only define a radius instead of a box.}}
====$radius:====
{{Table3615|
* Defines the radius of the detail sphere (''float''). If not provided, defaults to the submodel radius.}}

===$uvec:===
* Defines the "up" direction (vector) of a multipart turret. Usually it stands perpendicular to the ship surface. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''
* Forces turret normal into the same as the '''$uvec:'''.

===$fvec:===
* Defines the direction of the front a multipart turret will be facing. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''

===$lod0_name===
* Allows adding LODs to older models and changing from special points to modeled subsystems.
* Example $lod0_name=enginea used on a subobject named engine would allow engineb, engienc, and engined to be used while preserving backward compatibility.

===$attach_thrusters===
{{Table3615|
* Allows thrusters associated with this submodel to follow its rotations.}}

[[Category:Modding]]

Scripting.tbl

2012-01-21T15:33:51Z

Zookeeper: Documented $On Turret Fired

{{SCP_table}}

{{TableVersion|4500}}

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located here: ''[[List of Game States]]''
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found here: ''[[List of Game States]]''
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the filename of the last mission to have started. This condition will remain true even after the mission has been exited until another mission is started.
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 

===Actions===
;On Game Init: Executes immediately after game has been started.
::* No associated hook variables.
;On Splash Screen: Executes when initial game splash screen is shown
::* No associated hook variables.
;On State Start: Executed when specified game state starts
::* No associated hook variables.
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.
;On Key Pressed: Executed when specified key is pressed
::* '''Key''', The pressed key
;On Key Released: Executed when specified key is released
::* '''Key''', The released key
;On Mouse Moved: Executed when mouse is moved
::* No associated hook variables.
;On Mouse Pressed: Executed when mouse button is pressed
::* No associated hook variables.
;On Mouse Released: Executed when mouse button is released
::* No associated hook variables.
;On State End: Executed when specified game state ends
::* No associated hook variables.
;On Mission Start: Executed when mission starts
::* No associated hook variables.
{{Table3615|
;On Gameplay Start: Executed when the gameplay part of a mission starts
::* No associated hook variables.}}
;On HUD Draw: Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)
;On Weapon Collision: Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)
;On Debris Collision: Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)
;On Warp In:Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)
;On Warp Out: Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)
;On Death: On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists
;On Mission End: Run on mission end.
::* No associated hook variables.
{{Table3613|
;On Weapon Equipped: Runs once each frame, for every ship that has the weapon defined in the $Weapon class condition equipped.
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Fired: Runs once when a ship fires a weapon defined in the $Weapon class condition
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Selected: Runs once when a bank with a weapon defined in the $Weapon class condition is selected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Deselected: Runs once when a bank with a weapon defined in the $Weapon class condition is deselected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}
{{Table3615|
;On Turret Fired: Executed when a turret fires
::* '''Ship''', the parent ship
::* '''Weapon''', the weapon which was fired
::* '''Target''', the intended target}}

;Other hook variables:
::* '''Viewer''', active if (non-player) viewing object is valid
::* '''Player''', active if player obj is valid
 

==Examples==
See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Hud gauges.tbl

2012-01-05T20:40:52Z

Zookeeper: Documented new targetbox features

{{SCP table}}

{{TableVersion|????}}

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. Not all gauges can be modified. However, it can still be used to add custom gauges equivalent to something like the wingman status display.

NOTE: The following information is only applicable for builds based on Antipodes 7.

==Gauge system overview==

*HUD Elements in FS2 are called Gauges. Each gauge has various options to customize appearance and, in some cases, gauge behaviour.

==Table Contents==

===$Load Retail Configuration:===
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
*Syntax: '''Boolean'''

===$Font:===
*Which font to use for the HUD.
*Syntax: '''Integer''', font index as defined in fonts.tbl

===$Max Directives:===
*Maximum number of directives displayed simultaneously.
*Syntax: '''Integer''', default is 5.

===$Max Escort Ships:===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.
*Syntax: '''Integer'''

===$Length Unit Multiplier:===
*Defines the multiplier used for scaling the distances reported to the player in the game
*Syntax: '''Float'''

===$Speed Unit Multiplier:===
*Analogous to the above, this multiplier is applied to all speeds reported to the player
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above

===$Wireframe Targetbox:===
*Defines the default draw method for the targetbox
*Syntax: '''Integer'''
**Options:
::* '''0''' - Standard with full bright lighting
::* '''1''' - Wireframe
::* '''2''' - Standard with proper lighting
{{Table3615|
::* '''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

===$Targetbox Shader Effect:===
{{Table3615|
*Syntax: '''Integer'''
*If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects]], but that a table entry for the effect is not needed.}}

===$Lock Wireframe Mode:===
*If set, prevents targetbox draw method from being changed during the gaming session. This can be used by modders to define an unchangable look for their mod.
*Syntax: '''Boolean'''

===$Reticle Style:===
*Selection for display type of the Reticle.
*Syntax: '''String'''
**Options:
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
::* '''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==

===$Ship:===
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
*Syntax: '''String''', the ship class name

====$Load Retail Configuration:====
*As per the global option above.
*Syntax: '''Boolean'''

====$Font:====
*As per the global option above.
*Syntax: '''Integer'''

===$Base:===
*Base resolution for this config.
*Syntax: '''(Integer, Integer)'''

===$Required Aspect:===
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
*Syntax: '''String''', either "Full Screen" or "Wide Screen".

===$Min:===
*Minimum resolution for this config.
*Syntax: '''(Integer, Integer)'''

===$Max:===
*Maximum resolution for this config.
*Syntax: '''(Integer, Integer)'''

===$Gauges:===

====+Custom:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Name:=====
*Name of this custom gauge.
*Syntax: '''String''', max length 32 characters

=====Text:=====
*Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
*Syntax: '''String''', max length 32 characters

=====X Offset:=====
*Text will be displayed with an offset of x pixels from the gauge origin.
*Syntax: '''Integer'''

=====Y Offset:=====
*Text will be displayed with an offset of y pixels from the gauge origin.
*Syntax: '''Integer'''

=====Gauge Type:=====
*Each custom gauge must have a type.
*Syntax: '''String''', one of the possible [[gauge types]].

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Color:=====
*Optional. Defines the colour to use for this gauge.
*Syntax: '''Integer Integer Integer'''

=====Active by default:=====
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

====+Messages:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Max Lines:=====
*Optional. Maximum number of message lines that are displayed.
*Syntax: '''Integer''', default is 3

=====Max Width:=====
*Optional. How many pixels the message lines may be long.
*Syntax: '''Integer'''

=====Line Height:=====
*Optional. Vertical separation between message lines in pixels.
*Syntax: '''Integer'''

=====Total Lifetime:=====
*Optional. Message lifetime in milliseconds.
*Syntax: '''Integer'''

=====Scroll Time:=====
*Optional. Time to scroll one line.
*Syntax: '''Integer'''

=====Step Size:=====
*Optional.
*Syntax: '''Integer'''

====+Training Messages:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer''

====+Support:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Header Offsets:=====
=====Text Y-offset:=====
=====Dock Status X-offset:=====
=====Dock Time X-offset:=====

====+Damage:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Top Background Filename:=====
=====Entry Background Filename:=====
=====Bottom Background Filename:=====
=====Header Offsets:=====
=====Hull Integrity Offsets:=====
=====Hull Integrity Value X-offset:=====
=====Top Background Height:=====
=====Subsystem Entry Height:=====
=====Subsystem List Start Offsets:=====
=====Subsystem Entry Value X-offset:=====

====+Wingman Status:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Left Background Filename:=====
=====Entry Background Filename:=====
=====Right Background Filename:=====
=====Dot Filename:=====
=====Header Offsets:=====
=====Left Background Width:=====
=====Entry Width:=====
=====Single Wing Offsets:=====
=====Multiple Wing Start Offsets:=====
=====Wing Name Offsets:=====
=====Dot Offsets:=====
=====Expansion Mode:=====

====+Auto Speed:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
=====Auto Offsets:=====
=====Speed Offsets:=====

====+Auto Target:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Auto Offsets:=====
=====Target Offsets:=====

====+Countermeasures:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Text Offsets:=====
=====Value Offsets:=====

====+Talking Head:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
=====Header Offsets:=====
=====Animation Offsets:=====
=====Animation Background Size:=====

====+Directives:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Top Background Filename:=====
=====Entry Background Filename:=====
=====Bottom Background Filename:=====
=====Header Offsets:=====
=====Top Background Height:=====
=====List Start Offsets:=====
=====Entry Height:=====

====+Weapons:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Top Background Filename:=====
=====Entry Background Filename:=====
=====Bottom Background Filename:=====
=====Header Offsets:=====
=====List Start Offsets:=====
=====Top Background Height:=====
=====Entry Height:=====
=====Command X-offset:=====
=====Page Up Offsets:=====
=====Page Down Offsets:=====

====+Lag:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

====+Mini Target Shields:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====3 Digit Hull Offsets:=====
=====2 Digit Hull Offsets:=====
=====1 Digit Hull Offsets:=====

====+Player Shields:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Target Shields:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Escort View:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Top Background Filename:=====
=====Entry Background Filename:=====
=====Bottom Background Filename:=====
=====Entry Height:=====
=====Entry Stagger Width:=====
=====Header Text:=====
=====Header Offsets:=====
=====List Start Offsets:=====
=====Hull X-offset:=====
=====Name X-offset:=====
=====Status X-offset:=====

====+Mission Time:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Text Offsets:=====
=====Value Offsets:=====

====+ETS Weapons:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Height:=====
=====Letter Offsets:=====
=====Top Offsets:=====
=====Bottom Offsets:=====

====+ETS Engines:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Height:=====
=====Letter Offsets:=====
=====Top Offsets:=====
=====Bottom Offsets:=====

====+ETS Shields:====

=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Height:=====
=====Letter Offsets:=====
=====Top Offsets:=====
=====Bottom Offsets:=====

====+Target Monitor:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Monitor Filename:=====
=====Integrity Bar Filename:=====
=====Viewport Offsets:=====
=====Viewport Size:=====
=====Integrity Bar Offsets:=====
=====Integrity Bar Foreground Clip Height:=====
=====Status Offsets:=====
=====Name Offsets:=====
=====Class Offsets:=====
=====Distance Offsets:=====
=====Speed Offsets:=====
=====Hull Offsets:=====
=====Cargo Contents Offsets:=====
=====Cargo Scan Start Offsets:=====
=====Cargo Scan Size:=====

====+Extra Target Data:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Bracket Offsets:=====
=====Dock Offsets:=====
=====Order Offsets:=====
=====Time Offsets:=====

====+Radar:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Infinity Distance Offsets:=====
=====Long Distance Offsets:=====
=====Short Distance Offsets:=====

====+Radar Orb:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Infinity Distance Offsets:=====
=====Long Distance Offsets:=====
=====Short Distance Offsets:=====

====+Radar BSG:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Size:=====
=====XY Disc Filename:=====
=====XZ YZ Disc Filename:=====
=====Sweep Disc Filename:=====
=====Default Contact Filename:=====
=====Unknown Contact Filename:=====
=====Cockpit Target:=====
======Canvas Size:======
======Display Offset:======
======Display Size:======

====+Afterburner Energy:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Height:=====

====+Weapon Energy:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Height:=====
=====Text Offsets:=====

====+Text Warnings:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Center Reticle:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Firepoint display:=====
*Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

=====Firepoint size:=====
*Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

=====Firepoint X coordinate multiplier:=====
=====Firepoint Y coordinate multiplier:=====

====+Throttle:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Foreground Clip Bottom Y-offset:=====
=====Foreground Clip Width:=====
=====Foreground Clip Height:=====
=====Afterburner Clip Height:=====
=====Show Background:=====
=====Max Speed Label Offsets:=====
=====Min Speed Label Offsets:=====
=====Orbit Center Offsets:=====
=====Orbit Radius:=====

====+Threat Indicator:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Arc Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Dumbfire Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Lock Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Dumbfire Offsets:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Lock Offsets:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

====+Multiplayer Messages:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

====+Voice Status:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Ping:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Supernova:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

====+Lock Indicator:====
=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Lock Filename:=====
=====Locked Filename:=====
=====Lock Center Offsets:=====
=====Locked Center Offsets:=====

====+Offscreen Indicator:====
=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

====+Target Brackets:====
=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Dot Filename:=====

====+Hostile Triangle:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Radius:=====
=====Triangle Base:=====
=====Triangle Height:=====

====+Target Triangle:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Radius:=====
=====Triangle Base:=====
=====Triangle Height:=====

====+Missile Triangles:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Radius:=====
=====Triangle Base:=====
=====Triangle Height:=====

====+Lead Indicator:====
=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Center Offsets:=====

====+Orientation Tee:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Radius:=====

====+Lead Sight:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

====+Kills:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Filename:=====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

=====Text Offsets:=====
=====Value Offsets:=====

====+Weapon Linking:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

=====Slew:=====
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Syntax: '''Boolean'''

=====Arc Filename:=====
=====Single Primary Filename:=====
=====Double Primary Filename:=====
=====Single Secondary Filename:=====
=====Double Secondary Filename:=====
=====Triple Secondary Filename:=====
=====Single Primary Offsets:=====
=====Double Primary Offsets:=====
=====Single Secondary Offsets:=====
=====Double Secondary Offsets:=====
=====Triple Secondary Offsets:=====

====+Fixed Messages:====
=====Position:=====
*Screen coordinates for this gauge
*Syntax: '''(Integer, Integer)'''

=====Font:=====
*As per the global option above.
*Syntax: '''Integer'''

[[Category:Tables]]

Scripting.tbl

2011-11-29T22:00:25Z

Zookeeper: Documented the new $On Gameplay Start hook

'''''This feature requires SCP''''' 

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located here: ''[[List of Game States]]''
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found here: ''[[List of Game States]]''
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the filename of the last mission to have started. This condition will remain true even after the mission has been exited until another mission is started.
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 

===Actions===
;On Game Init: Executes immediately after game has been started.
::* No associated hook variables.
;On Splash Screen: Executes when initial game splash screen is shown
::* No associated hook variables.
;On State Start: Executed when specified game state starts
::* No associated hook variables.
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.
;On Key Pressed: Executed when specified key is pressed
::* '''Key''', The pressed key
;On Key Released: Executed when specified key is released
::* '''Key''', The released key
;On Mouse Moved: Executed when mouse is moved
::* No associated hook variables.
;On Mouse Pressed: Executed when mouse button is pressed
::* No associated hook variables.
;On Mouse Released: Executed when mouse button is released
::* No associated hook variables.
;On State End: Executed when specified game state ends
::* No associated hook variables.
;On Mission Start: Executed when mission starts
::* No associated hook variables.
{{Table3615|
;On Gameplay Start: Executed when the gameplay part of a mission starts
::* No associated hook variables.}}
;On HUD Draw: Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)
;On Weapon Collision: Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)
;On Debris Collision: Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)
;On Warp In:Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)
;On Warp Out: Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)
;On Death: On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists
;On Mission End: Run on mission end.
::* No associated hook variables.
{{Table3613|
;On Weapon Equipped: Runs once each frame, for every ship that has the weapon defined in the $Weapon class condition equipped.
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Fired: Runs once when a ship fires a weapon defined in the $Weapon class condition
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Selected: Runs once when a bank with a weapon defined in the $Weapon class condition is selected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
;On Weapon Deselected: Runs once when a bank with a weapon defined in the $Weapon class condition is deselected
::* '''User''', the ship carrying the weapon
::* '''Target''', the ships' current target
}}

;Other hook variables:
::* '''Viewer''', active if (non-player) viewing object is valid
::* '''Player''', active if player obj is valid
 

==Examples==
See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Ships.tbl

2011-11-12T20:08:58Z

Zookeeper: Documented $Warpout Engage Time

{{Fileversion|7923}}


==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Same for sliding as the $Forward accel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Same for sliding as the $Forward decel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's facing without changing its direction.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used as the warpin effect.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, defaults to 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons and shields recharge.
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, 0.01 equals 1% of total hitpoints recharged per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds
{{Table3611|
====+Aburn Max Reverse Vel:====
*Defined only for the reverse acceleration, Set the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
====+Aburn Rev accel:====
*Defined only for the reverse acceleration. In same format as $Forward accel:
*Syntax: '''''Float''''', seconds'''''}}
====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String, String'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===[[Subsystem]]<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible to player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Asteroid.tbl

2011-11-12T19:12:15Z

Zookeeper: Documented $Explosion Animations and $Explosion Radius Mult

{{TableVersion|5211|5264}}

==General Format==
*Asteroid.tbl is used to define all asteroids and debris pieces in-game.
*'''#Asteroid Types'''
*Asteroid and debris data
*'''#End'''
*'''$Impact Explosion:'''
**Defines the effect used when weapon strikes at asteroid
**Syntax: ''Filename''
*'''$Impact Explosion Radius:'''
**Defines the radius of the effect
**Syntax: ''Value'', (meters)

==Asteroid and Debris Data==
*Used to define asteroid types and their physical characteristics
*First three entries are different sized asteroids, small medium and large respectively
*Next three are debris pieces for the 1st species in the [[species_defs.tbl]]
*And so on in series of three

===$Name:===
*Defines the name of asteroid or debris object

===$POF file1:===
*Defines the name of the model file (.pof) used for asteroid or debris model
*Syntax: '''String.pof''', filename

===$POF file2:===
*'''''Note: This does not work for debris chunks. The game will always only use POF file1.'''''
*Defines the name of the alternate asteroid or debris model of the set size
*Syntax: '''String.pof''' or '''none''', filename

===$POF file3:===
*'''''Note: This does not work for debris chunks. The game will always only use POF file1.'''''
*Defines the name of the alternate asteroid model
*If the object in question is has '''$POF file2:''' set as ''none'' then this entry is not needed
*Syntax: '''String.pof''' or '''none''', filename

===$Detail distance:===
*Definies the distance where the change between different Levels-Of-Details (LODs) occurs
*Syntax: ( '''Integer list''' ), comma separated '''integers''', one for each LOD
**Example: (0, 30, 80, 150)

===$Max Speed:===
*Defines the maximum velocity of the asteroid
*Syntax: '''Float''', meters per second

===$Damage Type:===
{{Table3610|
*Defines the damage type of the asteroid explosion. '''REQUIRES ADDITIONAL TABLE FILE'''.
*Syntax: '''String''', name of the damage type as referenced in [[armor.tbl]]}}

===$Explosion Animations:===
{{Table3615|
*Defines the explosion animations used for the asteroid.
*Syntax: '''''Integer list''''', indices to fireballs defined in fireball.tbl}}

===$Explosion Radius Mult:===
{{Table3615|
*Defines the radius multiplier for the explosion fireballs, with a value of 1.0 causing the radius of the fireball to be equal to the radius of the asteroid. Defaults to 1.5 for large asteroids and 1.0 for others.
*Syntax: '''''Float'''''}}

===$Expl inner rad:===
*Radius at which the full explosion damage is done
*Syntax: '''Float''', meters

===$Expl outer rad:===
*Maximum radius at which any damage is done
*Syntax: '''Float''', meters

===$Expl damage:===
*Amount of damage done inside the inner radius
*Syntax: '''Float''', damage

===$Expl blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''Float''', blast effect

===$Hitpoints:===
*Defines the hitpoints of the asteroid or debris piece. Hitpoints are modified downward by skill level.
*Syntax: '''Float''', hitpoints

===$Split:===
{{Table3615|
*Defines what kind of asteroids this type of asteroid should split into when destroyed. You may define any number of $Split rules.
*Syntax: '''Integer''', an asteroid index. The first asteroid defined by the table has index 0, the second one has index 1, and so on.
*'''+Min:'''
**The minimum number of spawned asteroids. Default 0.
**Syntax: '''Integer'''
*'''+Max:'''
**The maximum number of spawned asteroids. Default 0.
**Syntax: '''Integer'''}}

==Sample==
*Single asteroid entry fos retail FS2 table

<pre>
#Asteroid Types

$Name: Small Asteroid
$POF file1: ast03.pof
$POF file2: asta03.pof
$POF file3: astb03.pof
$Detail distance: (0, 30, 80, 150)
$Max Speed: 60.0
$Expl inner rad: 0.0
$Expl outer rad: 0.0
$Expl damage: 0.0
$Expl blast: 0.0
$Hitpoints: 23

#End

$Impact Explosion: ExpMissilehit1
$Impact Explosion Radius: 20.0
</pre>

[[Category:tables]]

Ai profiles.tbl

2011-11-12T19:04:13Z

Zookeeper: Documented $no warp camera

{{SCP_table}}

{{TableVersion|5211|5707}}

Ai_profiles.tbl allows the creation and management of different patterns of AI behavior, called profiles. Profiles consist of various statistics and flags that provide some control over AI behavior. All options within a profile are optional; if an option is not specified it will follow the original FreeSpace 2 retail behavior. Different missions can specify different profiles.

There is a "hidden" profile called FS2 RETAIL that is hard-coded into FreeSpace Open and cannot be modified. It is always the default profile unless another is specified using $Default Profile.

==General Format==
'''#AI Profiles'''

'''$Default Profile:''' ''a profile name''

''Up to 9 different AI profiles''

'''#End'''

==#AI Profiles==
*Indicates to the parser that this is an ai_profiles table file.

===$Default Profile:===
*Defines the profile that each mission will use if no profile is specified in FRED. In addition, this profile will be selected automatically in FRED when you create a new mission. If this line is not specified, the default profile will be the FreeSpace 2 retail behavior.

===$Profile Name:===
*The name of the profile, naturally.

----

The following entries accept '''float list''' of five comma-separated values. One value for each of the difficulty levels (Very Easy, Easy, Medium, Hard, Insane).

===$Player Afterburner Recharge Scale:===
{{Table3610|
*Sets the speed of afterburner recharge
*Syntax: '''Float list'''
**Default: 5, 3, 2, 1.5, 1}}

===$Max Beam Friendly Fire Damage:===
{{Table3610|
*Defines the maximum damage inflicted by friendly beam fire
*Syntax: '''Float list'''
**Default: 0, 5, 10, 20, 30}}

===$Player Countermeasure Life Scale:===
{{Table3610|
*Sets the factor applied to player launched countermeasure lifetime
*Syntax: '''Float list'''
**Default: 3, 2, 1.5, 1.25, 1}}

===$AI Countermeasure Firing Chance:===
{{Table3610|
*Defines the chance a countermeasure will be fired by an AI-controlled ship (this is scaled by ai_class)
*Syntax: '''Float list'''
**Default: 0.2, 0.3, 0.5, 0.9, 1.1}}

===$AI In Range Time:===
{{Table3610|
*Defines the seconds added to the time it takes for an enemy to come in range of (i.e. target) a friendly ship
*Syntax: '''Float list'''
**Default: 2, 1.4, 0.75, 0, -1}}

===$AI Always Links Ammo Weapons:===
{{Table3610|
*AI ships will link ballistic primaries if ammo levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 95, 80, 60, 40, 20}}

===$AI Maybe Links Ammo Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Ammo Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Primary Ammo Burst Multiplier:===
{{Table3611|
*Allows the AI to fire primary weapons in bursts. How long the bursts are (and how much time between them) is a function of ammo remaining, distance to target, angle to target, and this multiplier. A value of 0 turns this feature off (AI fires normally, without bursts). A value < 1 will make for shorter bursts with larger gaps, and a value > 1 will give longer bursts with shorter gaps.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$AI Always Links Energy Weapons:===
{{Table3610|
*AI ships will link energy primaries if energy levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 100, 80, 60, 40, 20}}

===$AI Maybe Links Energy Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Energy Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Max Missles Locked on Player:===
{{Table3610|
*Defines the maximum number of missiles allowed to be homing in on a player at any given time
*Note: Single-player only, no restriction in multiplayer
*Syntax: '''Float list'''
**Default: 2, 3, 4, 7, 99}}

===$Max Player Attackers:===
{{Table3610|
*Sets the maximum number of ships allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 2, 3, 4, 5, 99}}

===$Max Incoming Asteroids:===
{{Table3610|
*Sets the maximum number of active (i.e. "thrown") asteroids that can be heading toward a friendly ship at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 5, 7, 10}}

===$Player Damage Factor:===
{{Table3610|
*Defines the factor applied to damage suffered by the player
*Syntax: '''Float list'''
**Default: 0.25, 0.5, 0.65, 0.85, 1}}

===$Player Subsys Damage Factor:===
{{Table3610|
*Sets the factor applied to subsystem damage suffered by the player. This is in addition to the '''$Player Damage Factor:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$Predict Position Delay:===
{{Table3610|
*Sets the measure of time (in F1_0 units) after which the AI will recalculate the position of its target
*Syntax: '''Float list'''
**Default: 2, 1.5, 1.333, 0.5, 0}}

===$Player Shield Recharge Scale:===
{{Table3610|
*Sets the factor applied to the speed at which the player's shields recharge
*Syntax: '''Float list'''
**Default: 4, 2, 1.5, 1.25, 1}}

===$AI Shield Manage Delay:===
{{Table3610|
*Also '''$AI Shield Manage Delays:'''
*Sets the time in seconds between each instance of an AI ship managing its shields
*Syntax: '''Float list'''
**Default: 5, 4, 2.5, 1.2, 0.1}}

===$Friendly AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 2, 1.4, 1.25, 1.1, 1}}

===$Hostile AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 4, 2.5, 1.75, 1.25, 1}}

===$Player Subsys Damage Factor:===
{{Table3610|
*Also '''$AI Damage Reduction to Player Subsys:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$AI Turn Time Scale:===
{{Table3610|
*Defines the factor applied to time it takes for enemy ships to turn. A value of 1.0 means the ship turns at normal speed, 2.0 means half speed (takes twice as long), etc. Note that this value ONLY affects ships hostile to the player (always 1.0 for friendly ships).
*Syntax: '''Float list'''
**Default: 3, 2.2, 1.6, 1.3, 1}}

===$Glide Attack Percent:===
{{Table3611|
*How often the AI will use the "glide attack" move when it has the opportunity. Glide attack means using glide to maintain course while aiming and firing at the current target. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Circle Strafe Percent:===
{{Table3611|
*How often the AI will use the "circle strafe" move when it has the opportunity. Circle strafe means that the ship will attempt "Descent-like" combat, trying to maintain distance while circling around the target using sidethrusters. Ships will only attempt this when sidethrust top speed is at least 2/3 of target's current velocity.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Glide Strafe Percent:===
{{Table3611|
*How often the AI will use the "glide strafe" move when it has the opportunity. Glide strafe means using glide to attack capships by flying past and shooting at them. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Time Threshold:===
{{Table3611|
*The minimum amount of time required for the AI to detect a "stalemate" situation. If a ship and its target have been within a certain distance of each other (defined by ''$Stalemate Distance Threshold'') for this amount of time without either of them scoring a hit on the other, the AI will do something to break the stalemate. Only applies to small ships. If this value is 0 or less, no stalemate detection is performed.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Distance Threshold:===
{{Table3611|
*The maximum distance that an AI ship must remain from its target for a "stalemate" to occur (see ''$Stalemate Time Threshold'').
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Weapon Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's weapons recharge
*Syntax: '''Float list'''
**Default: 10, 4, 2.5, 2, 1.5}}

===$Max Turret Target Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the same target at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Max Turret Player Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Percentage Required For Kill Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.30, 0.30, 0.30, 0.30, 0.30}}

===$Percentage Required For Assist Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded an assist (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.15, 0.15, 0.15, 0.15, 0.15}}

===$Percentage Awarded For Capship Assist:===
{{Table3610|
*In TvT and Coop missions all teammates will be granted this percentage of the capships score when someone scores a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.5, 0.5, 0.5, 0.5, 0.5}}

===$Repair Penalty:===
{{Table3611|
*The amount to subtract from the player's score if they are repaired by a support ship
*Syntax: '''Integer list'''
**Default: 10, 20, 35, 50, 60}}

===$Delay Before Allowing Bombs to Be Shot Down:===
{{Table3611|
*Time after bombs are fired during which the bombs are invulnerable to weapon hits
*Syntax: '''Float list'''
**Default: 1.5, 1.5, 1.5, 1.5, 1.5}}

===$Chance AI Has to Fire Missiles at Player:===
{{Table3611|
*Chance - expressed in ('''value''' + 1) / 7 - of each AI turret within current 10 second segment to be allowed to shoot missiles at player ship.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4}}

===$Max Aim Update Delay:===
{{Table3611|
*Maximum amount of delay allowed before the AI will update its aim. Until the next update, the AI will project the target forward based on last checked position and velocity. Applies to small ships vs small ships (dogfights). The actual delay is randomly selected between 0 and the maximum (so setting a value of 2 will result in an average of 1 second delay).
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Turret Max Aim Update Delay:===
{{Table3611|
*As $Max Aim Update Delay, but affecting turrets instead
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}
----

The following entries are boolean flags. They can be set to ''YES'' or ''NO'', ''TRUE'' or ''FALSE'', ''OUI'' or ''NON'', ''HIja′'' or ''ghobe′'', etc. The default is ''NO''.

===$big ships can attack beam turrets on untargeted ships:===
{{Table3610|
*If set, big ships can attack a beam turret that's firing on them from a ship that they don't currently have targeted.}}

===$smart primary weapon selection:===
{{Table3610|
*If set, enables the new primary weapon selection method}}

===$smart secondary weapon selection:===
{{Table3610|
*If set, enables the new secondary weapon selection method (including proper use of bomber+ missiles)}}

===$smart shield management:===
{{Table3610|
*If set, shields will devote all their charging energy to the weakest quadrant(s) and not waste energy on fully-charged quadrants (previously was -smart_shields on the command line)}}

===$smart afterburner management:===
{{Table3610|
*If set, the AI will properly use brief pulses of afterburner power instead of afterburning until fuel is exhausted}}

===$allow rapid secondary dumbfire:===
{{Table3610|
*If set, allows an AI ship to switch to rapid fire for dumbfire missiles}}

===$huge turret weapons ignore bombs:===
{{Table3610|
*If set, causes huge turret weapons (including anti-capship beams) to not target bombs}}

===$don't insert random turret fire delay:===
{{Table3610|
*If set, removes the random turret fire delay (from .1 to .9 seconds) inserted in addition to AI Fire Delay Scale}}

===$hack improve non-homing swarm turret fire accuracy:===
{{Table3610|
*If set, triggers a hack to improves the accuracy of non-homing swarm missiles by firing them along the turret's last fire direction rather than the direction it currently faces
*Also disables swarm weapons ability to fire only on the 'turrets barrel line'.}}

===$shockwaves damage small ship subsystems:===
{{Table3610|
*If set, shockwaves will cause damage to small ship subsystems (like in FS1)}}

===$navigation subsystem governs warpout capability:===
{{Table3610|
*If set, ships will not be able to warp out if their navigation subsystem is destroyed or low in strength}}

===$ignore lower bound for minimum speed of docked ship:===
{{Table3610|
*If set, there will be no lower bound for the speed at which docked ships move (like in FS1).
*When a ship is towing another ship or ships, the towing ship will be slowed down to a degree depending on the total mass of all docked ships. In FS1, the ships could slow down to an arbitrarily slow speed, even a fraction of a m/s above zero. In FS2, there is a lower bound on this behavior so that all ships are guaranteed to move at a minimum docked speed. When set, this flag removes the lower bound and restores FS1 behavior.}}

===$disable linked fire penalty:===
{{Table3610|
*If set, there will be no penalty for linking primaries. Normally, the rate of fire is divided by the number of linked guns.}}

===$disable weapon damage scaling:===
{{Table3610|
*If set, weapons will do the same damage to a ship regardless of "big damage", "supercap", etc. ship types.}}

===$use additive weapon velocity:===
{{Table3610|
*If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly. This also improves the accuracy of weapons fired while gliding.}}

===$use newtonian dampening:===
{{Table3610|
*Newtonian Dampening changes turning and acceleration behavior. By default, there's quite a bit of slide when you turn, and when combined with high damp values (such as in BtRL), you can actually push your speed up beyond the max. Newtonian Dampening is the more realistic turns, where too much turning will lower your speed. Forward momentum is also affected. Backslash can explain it in more detail. [http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741] }}

===$include beams for kills and assists:===
{{Table3610|
*If set, beam damage is counted when calculating kills and assists.}}

===$score kills based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the killer inflicted on the dead ship.}}

===$score assists based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the player gaining the assist inflicted on the dead ship.}}

===$allow event and goal scoring in multiplayer:===
{{Table3610|
*If set, players (rather than just their team) can gain score from events in multiplayer.}}

===$fix linked primary weapon decision bug:===
{{Table3610|
*If set, the AI will properly link primaries according to specified percentages of energy levels instead of retail behavior where it mistakenly linked according to absolute energy levels.}}

===$prevent turrets targeting too distant bombs:===
{{Table3610|
*If set, prevents turrets from targeting bombs beyond maximum range of the weapons of the turret.}}

===$smart subsystem targeting for turrets:===
{{Table3610|
*If set, prevents turrets from trying to target subsystems beyond their fov limits, also keeps the turret subsystem targeting preference order intact regardless of the angle to the target.}}

===$fix heat seekers homing on stealth ships bug:===
{{Table3610|
*If set, heat-seeking missiles will not home in on stealth ships (this mirrors the established behavior where heat-seeking missiles do not home in on ships that are hidden from sensors).}}

===$multi allow empty primaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without primaries.}}

===$multi allow empty secondaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without secondaries.}}

===$allow turrets target weapons freely:===
{{Table3611|
*If set, allows turrets to target any weapons instead of just targeting bombs, to be used in conjunction with target priorities setup.}}

===$use only single fov for turrets:===
{{Table3611|
*If set, allows turrets to fire outside some hardcoded FOV set for certain missile types limits, and rely only on the user defined FOV.}}

===$allow vertical dodge:===
{{Table3611|
*If set, allows ships to dodge weapons fire vertically as well as horizontally.}}

===$force beam turrets to use normal fov:===
{{Table3611|
*If set makes beam turrets use same FOV rules as other weapons do. Prevents beam from a turret from following the target beyond the turret's FOV}}

===$fix AI class bug:===
{{Table3611|
*Fixes a bug where AI class attributes are not set properly on ships if the AI class is set in the mission to something other than the default for the ship type. Set this to YES if you want attributes in [[Ai.tbl]] to mean anything at all.}}

===$No extra collision avoidance vs player:===
{{Table3611|
*Disables the extra collision avoidance that AI normally uses against the player. Makes the AI more aggressive vs the player at close range (same treatment as vs other AI), although ship-ship collisions are slightly more likely.}}

===$all ships manage shields:===
{{Table3613|
*Allows AI to manage shields on big ships}}

===$ai aims from ship center:===
{{Table3613|
*AI aims weapons using the center of the ship instead of the first gunpoint. If a convergence offset is specified for this ship in ships.tbl, AI aims using that as a reference point. Default: NO.}}

===$allow primary link delay:===
{{Table3613|
*When set, no ships will link primaries for the first 30 seconds of a mission. In addition, ships will randomly not link for the first two minutes of a mission. Set this to NO to get rid of this often-problematic retail behavior. Default: YES.}}

===$allow beams to damage bombs:===
{{Table3613|
*When set, beam weapons will be able to effectively intercept bombs. In addition, bombs flying through a beam path will get damaged and destroyed. Default: NO.}}

===$disable weapon damage scaling for player:===
{{Table3613|
*When set, Player weapon damage will no longer be scaled down when firing a non-huge primary against a ship with the "big damage" flag. Use with caution, as this may severely impact mission balance. Default: NO.}}

===$ai path mode:===
{{Table3613|
*Possible options are "normal" and "alt1". The alt1 mode differs from the normal behaviour in the following ways:
**1. No path shortcutting. Normal pathing AI will skip forward along a path to the furthest point it can reach. This is sometimes desirable, but makes it a lot harder to predict how the AI is going to behave at various points along a path. Turning this off also allows us to force the AI to straighten out, by giving it several waypoints in a more-or-less straight line. This is useful for such things as lining up a landing.
**2. No sliding when following paths. Docking still works, but there is some code that causes the AI to go full retard if it just misses a point: it turns towards the point in big, looping circles. This is apparently caused by passing a slide_vec value into ai_turn_towards_vector, which doesn't even seem to do what you'd expect it to do. Passing a null value instead turns off the stupid.
**3. Momentum taken into account when following paths. Path points will trigger sooner, proportional to the ship's speed and momentum. This prevents the AI from massively overshooting a waypoint, especially with high-damp ships.
**4. AI tries to follow the line between waypoints. Instead of just pointing at the next waypoint, the AI will fly a bit towards the line. This helps keep the AI actually on the path it claims to be following. See picture:[[Image:Altpaths.png]]
Blue is what happens with regular pathing. Red is the modified pathing: as you can see, it actively moves back towards the line.}}

===$Default weapon select effect:===
{{Table3613|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}

===$Default ship select effect:===
{{Table3613|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}

===$no warp camera:===
{{Table3615|
*When set, prevents the view from switching to the external camera when the player warps out.
*Note: this flag is deprecated and may get moved to another table without further notice.}}

==Sample Entry==
*Retail FS2 behaviour

<pre>
#AI Profiles

$Default Profile: FS2 RETAIL

$Profile Name: FS2 RETAIL

$Player Afterburner Recharge Scale: 5, 3, 2, 1.5, 1
$Max Beam Friendly Fire Damage: 0, 5, 10, 20, 30
$Player Countermeasure Life Scale: 3, 2, 1.5, 1.25, 1
$AI Countermeasure Firing Chance: 0.2, 0.3, 0.5, 0.9, 1.1
$AI In Range Time: 2, 1.4, 0.75, 0, -1
$AI Always Links Ammo Weapons: 95, 80, 60, 40, 20
$AI Maybe Links Ammo Weapons: 90, 60, 40, 20, 10
$AI Always Links Energy Weapons: 100, 80, 60, 40, 20
$AI Maybe Links Energy Weapons: 90, 60, 40, 20, 10
$Max Missles Locked on Player: 2, 3, 4, 7, 99
$Max Player Attackers: 2, 3, 4, 5, 99
$Max Incoming Asteroids: 3, 4, 5, 7, 10
$Player Damage Factor: 0.25, 0.5, 0.65, 0.85, 1
$Player Subsys Damage Factor: 0.2, 0.4, 0.6, 0.8, 1
$Predict Position Delay: 2, 1.5, 1.33, 0.5, 0
$AI Shield Manage Delay: 5, 4, 2.5, 1.2, 0.1
$Friendly AI Fire Delay Scale: 2, 1.4, 1.25, 1.1, 1
$Hostile AI Fire Delay Scale: 4, 2.5, 1.75, 1.25, 1
$AI Turn Time Scale: 3, 2.2, 1.6, 1.3, 1
$Player Shield Recharge Scale: 4, 2, 1.5, 1.25, 1
$Player Weapon Recharge Scale: 10, 4, 2.5, 2, 1.5
$Max Turret Target Ownage: 3, 4, 7, 12, 19
$Max Turret Player Ownage: 3, 4, 7, 12, 19
$Percentage Required For Kill Scale: 0.30, 0.30, 0.30, 0.30, 0.30
$Percentage Required For Assist Scale: 0.15, 0.15, 0.15, 0.15, 0.15
$Percentage Awarded For Capship Assist: 0.5, 0.5, 0.5, 0.5, 0.5
$Repair Penalty: 10, 20, 35, 50, 60
$Delay Before Allowing Bombs to Be Shot Down: 1.5, 1.5, 1.5, 1.5, 1.5

$big ships can attack beam turrets on untargeted ships: NO
$smart primary weapon selection: NO
$smart secondary weapon selection: NO
$smart shield management: NO
$smart afterburner management: NO
$allow rapid secondary dumbfire: NO
$huge turret weapons ignore bombs: NO
$don't insert random turret fire delay: NO
$hack improve non-homing swarm turret fire accuracy: NO
$shockwaves damage small ship subsystems: NO
$navigation subsystem governs warpout capability: NO
$ignore lower bound for minimum speed of docked ship: NO
$disable linked fire penalty: NO
$disable weapon damage scaling: NO
$use additive weapon velocity: NO
$use newtonian dampening: NO
$include beams for kills and assists: NO
$score kills based on damage caused: NO
$score assists based on damage caused: NO
$allow event and goal scoring in multiplayer: NO
$fix linked primary weapon decision bug: NO
$prevent turrets targeting too distant bombs: NO
$smart subsystem targeting for turrets: NO
$fix heat seekers homing on stealth ships bug: NO
$multi allow empty primaries: NO
$multi allow empty secondaries: NO
$allow turrets target weapons freely: NO
$use only single fov for turrets: NO
$allow vertical dodge: NO
$fix AI class bug: NO
#End
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741 Re: New difficulty? - Feature request!]", ''Hard Light Productions Forums'', Hard Light Productions, 2007-12-15. Retrieved on [[December_27]], [[2007]].

[[Category:Tables]]

Asteroid.tbl

2011-11-12T18:26:20Z

Zookeeper: Documented $Split

{{TableVersion|5211|5264}}

==General Format==
*Asteroid.tbl is used to define all asteroids and debris pieces in-game.
*'''#Asteroid Types'''
*Asteroid and debris data
*'''#End'''
*'''$Impact Explosion:'''
**Defines the effect used when weapon strikes at asteroid
**Syntax: ''Filename''
*'''$Impact Explosion Radius:'''
**Defines the radius of the effect
**Syntax: ''Value'', (meters)

==Asteroid and Debris Data==
*Used to define asteroid types and their physical characteristics
*First three entries are different sized asteroids, small medium and large respectively
*Next three are debris pieces for the 1st species in the [[species_defs.tbl]]
*And so on in series of three

===$Name:===
*Defines the name of asteroid or debris object

===$POF file1:===
*Defines the name of the model file (.pof) used for asteroid or debris model
*Syntax: '''String.pof''', filename

===$POF file2:===
*'''''Note: This does not work for debris chunks. The game will always only use POF file1.'''''
*Defines the name of the alternate asteroid or debris model of the set size
*Syntax: '''String.pof''' or '''none''', filename

===$POF file3:===
*'''''Note: This does not work for debris chunks. The game will always only use POF file1.'''''
*Defines the name of the alternate asteroid model
*If the object in question is has '''$POF file2:''' set as ''none'' then this entry is not needed
*Syntax: '''String.pof''' or '''none''', filename

===$Detail distance:===
*Definies the distance where the change between different Levels-Of-Details (LODs) occurs
*Syntax: ( '''Integer list''' ), comma separated '''integers''', one for each LOD
**Example: (0, 30, 80, 150)

===$Max Speed:===
*Defines the maximum velocity of the asteroid
*Syntax: '''Float''', meters per second

===$Damage Type:===
{{Table3610|
*Defines the damage type of the asteroid explosion. '''REQUIRES ADDITIONAL TABLE FILE'''.
*Syntax: '''String''', name of the damage type as referenced in [[armor.tbl]]}}

===$Expl inner rad:===
*Radius at which the full explosion damage is done
*Syntax: '''Float''', meters

===$Expl outer rad:===
*Maximum radius at which any damage is done
*Syntax: '''Float''', meters

===$Expl damage:===
*Amount of damage done inside the inner radius
*Syntax: '''Float''', damage

===$Expl blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''Float''', blast effect

===$Hitpoints:===
*Defines the hitpoints of the asteroid or debris piece. Hitpoints are modified downward by skill level.
*Syntax: '''Float''', hitpoints

===$Split:===
{{Table3615|
*Defines what kind of asteroids this type of asteroid should split into when destroyed. You may define any number of $Split rules.
*Syntax: '''Integer''', an asteroid index. The first asteroid defined by the table has index 0, the second one has index 1, and so on.
*'''+Min:'''
**The minimum number of spawned asteroids. Default 0.
**Syntax: '''Integer'''
*'''+Max:'''
**The maximum number of spawned asteroids. Default 0.
**Syntax: '''Integer'''}}

==Sample==
*Single asteroid entry fos retail FS2 table

<pre>
#Asteroid Types

$Name: Small Asteroid
$POF file1: ast03.pof
$POF file2: asta03.pof
$POF file3: astb03.pof
$Detail distance: (0, 30, 80, 150)
$Max Speed: 60.0
$Expl inner rad: 0.0
$Expl outer rad: 0.0
$Expl damage: 0.0
$Expl blast: 0.0
$Hitpoints: 23

#End

$Impact Explosion: ExpMissilehit1
$Impact Explosion Radius: 20.0
</pre>

[[Category:tables]]

Subobject and subsystem properties

2011-11-12T18:22:29Z

Zookeeper: Documented $attach_thrusters

This page documents the properties that can be applied to subobjects and to subsystems in their respective properties data in the [[Model files|model file]].

==Important notes==
* Subobject/subsystem properties data is not parsed in order.
* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
* Buffer size of 256 is reserved for the characters in properties data.

==Subsystem Properties==
* These can be applied to subsystems both with and without separate subobject.
{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''Key strings and their order for setting subsystems'''''
|-
| align="center"| ''engine''
| Engine subsystem
|-
| align="center"| ''radar''
| Radar dish subsystem
|-
| align="center"| ''turret''
| Turret subsystem
|-
| align="center"| ''navigation''
| Navigation subsystem
|-
| align="center"| ''communication''
| Communication subsystem
|-
| align="center"| ''weapon''
| Weapon control subsystem
|-
| align="center"| ''sensor''
| Sensor subsystem
|-
| align="center"| ''solar''
| Solar panel subsystem
|-
| align="center"| ''gas''
| Gas collector subsystem
|-
| align="center"| ''activator''
| '''''unused'''''
|-
|}

===$name===
*Defines the alternate name for the subsystem (''string'')
*Alternate subsystem names offer an alternative option for setting this via [[ships.tbl]] file or via mission data.

===$fov===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Defines the firing arc of the turret in degrees (''integer'')
*Defaults to 180 degrees if omitted.

===$crewspot===
*Valid only if the true subobject name (not the alternate defined above) contains string "turret" but not strings "radar" or "engine"
*Marks the turret as 'crewspot'
*Defines the name of the crewspot (''string'')
*No actual function

===$triggered:===
*Defines the subsystem as a rotating subsystem which can be triggered (animated) via [[Animation Code]]

===$rotate===
*Marks the subsystem as a rotating subsystem
*Defines the rotation time for the subsystem (''float'')

====$pbank====
*Marks the rotation as primary weapon rotation
*Defines the associated weapon bank (''integer'')


====$stepped====
*Defines the rotation as an stepped instead of continuous rotation

=====$steps=====
*Defines the number of steps in the animation (''integer'')
*Defaults to 8

=====$t_paused=====
*Defines the pause time between steps (''float'')
*Defaults to 2

=====$t_transit=====
*Defines the movement time between pauses (''float'')
*Defaults to 2

=====$fraction_accel=====
*Defines the fraction of the stepped rotation time used for acceleration (''float'')
*Is between 0 .. 0.5
*Defaults to 0.3

==Subobject Properties==
* These can be applied only to subsystem with their own separate subobject.

===$dumb_rotate:===
* Marks the subobject as 'dumb rotating object'
* Defines the rotation time (''float'')

===$special===
* Defines special attributes for the subobject
* String, either '''"subsystem"''' or '''"no_rotate"'''

===="subsystem"====
* '''subsystem''' marks the subobject as an subsystem

===="no_rotate"====
* Valid option if '''subsystem''' string was not used
* Marks subobject as an object that should not rotate

===$no_collisions===
* Prevents collision detection from occurring on this subobject and all of its children (recursively).

===$nocollide_this_only===
* Prevents collision detection from occurring on this subobject only (children collide normally).

===$collide_invisible===
* Allows full collision detection for things painted with the special "invisible" texture (normally ships collide but weapons do not)

===$gun_rotation:===
* Marks the submodel as using gun rotation

===[[Detail box|$detail_box:]]===
* Marks the subsystem as one with detail box
====[[Detail box|$box_min:]]====
====[[Detail box|$box_max:]]====

===$uvec:===
* Defines the "up" direction (vector) of a multipart turret. Usually it stands perpendicular to the ship surface. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''
* Forces turret normal into the same as the '''$uvec:'''.

===$fvec:===
* Defines the direction of the front a multipart turret will be facing. Doesn't need to be specified for multiparts with a vertical rotation axis.
* Reads three comma separated ''floats''

===$lod0_name===
* Allows adding LODs to older models and changing from special points to modeled subsystems.
* Example $lod0_name=enginea used on a subobject named engine would allow engineb, engienc, and engined to be used while preserving backward compatibility.

===$attach_thrusters===
{{Table3615|
* Allows thrusters associated with this submodel to follow its rotations.}}

[[Category:Modding]]