{{SCP_table}}
{{TableVersionGit|2024-08-26|91a673ac586a57e8f7793f08985b6f17a7fd1aa7}}
{{Tables}}

{{Table250|
This table has been significantly refactored for FSO 25.0.
For documentation of the old table style, see [[Legacy Particle Effects]]
}}

Particle Effects is a SCP feature which allows to define custom particle effects that can be assigned to various engine properties.

This table is one of the [[Modular Tables]] and can be extended with xxx-part.tbm. This table type '''''does not have a main table''''' like the other types. All particle effects must be specified in modular tables. Currently there is no support for the usual ''+nocreate'' ability the other modular tables have but that will be added in the future. Parts of this documentation are written with with ''+nocreate'' in mind for when that is implemented.

=General Info=
*Begins with #Particle Effects
*Contains zero or more particle effect definitions
*Ends with #End

Particle effects are created by specifying a name and a type. The type dictates which values are valid and will be described below.

{{Table250|
*Particles as described here and as described in [[Legacy Particle Effects]] both share the '''*-part.tbm''' table, and can exist alongside oneanother within the same file.
*As such, it is not required to refactor legacy-style particles to the new format, unless the usage of newer features is desired.
}}

=$Effect:=
*Creates a new effect and specifies its name. The name must be at least one character long.
*Syntax: '''String'''

==+Filename:==
*Sets the filename of the animation that should be used.
*Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)

==+Animation Reversed:==
*If this is true, the animation specified will play in reverse.
*Defaults to false.
*Syntax: '''''Boolean'''''

==+Bitmap Alignment:==
*Sets how the bitmap is aligned
*Syntax: One of '''Screen Aligned''', '''Random''', or '''Default''' (uses the setting defined globally in [[Game_settings.tbl#$Randomize particle rotation:]])

==+Radius:==
*Sets the radius of the created particles. This is a random range; see [[Parsed random range]].
*Exactly one of ''+Radius'' and ''+Parent Radius Factor'' is required.
*Syntax: See [[Parsed random range]]

==+Parent Radius Factor:==
*Sets the radius to be a factor of the current size of the particle that spawned it. Only works when spawned as a trail particle effect of another particle. This is a random range; see [[Parsed random range]].
*Syntax: See [[Parsed random range]]

==+Length:==
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a random range; see [[Parsed random range]].
*This is optional
*Syntax: See [[Parsed random range]]

==+Lifetime:==
*Sets the life time of the particles. This is a random range; see [[Parsed random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional, but only one between +Lifetime and +Parent Lifetime Factor may be used.
*Syntax: See [[Parsed random range]], or the string ''<none>''

==+Parent Lifetime Factor:==
*Sets the lifetime to be a factor of the remaining lifetime of the particle that spawned it. Only works when spawned as a trail particle effect of another particle. This is a random range; see [[Parsed random range]].
*This is optional, but only one between +Lifetime and +Parent Lifetime Factor may be used.
*Syntax: See [[Parsed random range]]

==+Remain local to parent:==
*If this is true, the effect will be 'parented' to its spawner, and will move with it, inheriting all changes to the spawner's position and orientation. Very useful for some types of muzzle effect.
*Defaults to false.
*Syntax: '''''Boolean'''''

==$Emits Light:==
*If this is tabled, the particle will emit light during its lifetime

===+Type:===
*The type of the light. Required if '''$Emits Light:''' is tabled.
*One of:
**''Point'' - Will be a point light source at the particle's position
**''As Particle'' - Will be a tube light the size of the particle if it has a length, will be a point light otherwise
**''To Last Position'' - Will be a tube light from the particles position on the last frame to the particles position on the current frame
**''Cone'' - Will be a cone light pointing in the direction of travel of the particle

===+Light Radius:===
*How far the light shines. Required if '''$Emits Light:''' is tabled.
*Syntax: '''''Float'''''

===+Light Source Radius:===
*How large the light source itself is. Defaults to 0.
*Syntax: '''''Float'''''

===+Intensity:===
*How bright the light is. Required if '''$Emits Light:''' is tabled.
*Syntax: '''''Float'''''

===+Color:===
*What color the light is. Required if '''$Emits Light:''' is tabled.
*Syntax: '''''Float''''' '''''Float''''' '''''Float''''' as R G B respectively

===+Cone Angle:===
*The angle of the outer cone of the light. Only has an effect for the cone type. Defaults to 0.
*Syntax: '''''Float'''''

===+Cone Inner Angle:===
*The angle of the inner cone of the light. Only has an effect for the cone type. Defaults to 0.
*Syntax: '''''Float'''''

==+Duration:==
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[Parsed random range]].

==+Delay:==
*Specifies after how much time after the effect is triggered the effect starts creating particles.
*This is optional
*Syntax: See [[Parsed random range]]

==+Spawns per second:==
*Specifies how many times per seconds particles will spawn from this effect. If this is not specified then the effect is triggered every frame. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*Batches of particles spawned at different points during a frame will be spawned at the correct positions along a moving spawner entity's trajectory, with millisecond precision, rather than all 'clumping' at the spawner's final position for that frame. This works for particles spawned from objects (like ships and weapons), and ones spawned from other particles (as with a $Trail effect), but does not currently work for particles spawned from beams.
*This is optional
*Syntax: ''number''. Must be greater than 0.

==+Particle Count Per Spawn:==
*Sets the amount of particles created every time this effect spawns new particles. This is a [[Parsed random range]].
*This setting is multiplicative with ''+Spawns per second:''. The former defines how often things are spawned, while ''+Particle Count Per Spawn:'' defined how many individual particles are spawned each time.
*Syntax: See [[Parsed random range]]

==+Direction:==
*Sets the direction of the particle spawner. This influences many following options, which will be marked with ''affected by orientation''. Can be one of:
**''Aligned'': The direction of the particle spawner will be aligned by whatever created it. This could be the direction a muzzle is facing, a weapon is flying, a beam is shooting, etc.
**''HitNormal'': The direction of the particle spawner will be set to the normal vector of the event that spawns the particle. This can be something like the normal vector of a weapon impact. If no normal vector exists for a given event, ''Aligned'' will be used instead.
**''Reflected'': The direction of the particle spawner will be set to the ''Aligned'' direction after it is reflected off using the normal vector. This is a good way of simulating armor deflecting a shot. If no normal vector is present in the current event, it'll be set to ''Aligned'' instead.
**''Reverse'': The reverse of the ''Aligned'' vector
*Optional
*Syntax: '''String''', one of the strings specified above

==+Position Offset:==
*Offsets the position of the particle source relative to the spawner. Positive Z means "forward".
*''affected by orientation''
*For effects spawned from sources will a full orientation, such as ships (including primary or secondary muzzle effects) and weapons (including hit effects), all three dimensions will work correctly.
*For effects spawned from sources that just have a defined forward vector, such as particles (as with trail effects) or beams, the X and Y axes will have no influence.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

==+Velocity Offset:==
*Adds a constant velocity to particles spawned by this spawner. Positive Z means "forward".
*''affected by orientation''
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

==+Spawn Position Volume:==
*Defines the volume around the particle effect spawner in which the particles will spawn (randomly distributed within the volume).
*''affected by orientation''
*Optional
*Syntax: One of the following types

===Spheroid===
====+Radius:====
*Specifies the radius of the volume
*Optional
*Syntax: float, default 1
====+Bias:====
*Causes the particles to spawn more frequently near the edges or near the center. Values greater than 1 bias the particles toward the center, less than 1 biases them towards the edge.
*Optional
*Syntax: float, default 1
====+Stretch:====
*'Stretches' or squashes the spherical volume into an ellipsoid. Values greater than 1 stretch it, less than 1 squashes it.
*Optional
*Syntax: float, default 1
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]].
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Radius Mult''', '''Bias Mult''', or '''Stretch Mult''', which are multipliers for the respective tabled values of the spheroid volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true
===Cone===
====+Deviation:====
*Specifies the standard deviation by how much an average particle will deviate from the given spawner direction in degrees.
*Exactly one of ''+Deviation'' or ''+Deviation Profile'' is required
*Syntax: float
====+Deviation Profile:====
*Specifies the deviation of a particle from the given spawner direction as a random range '''in radians'''.
*Syntax: See [[Parsed random range]]

====+Length:====
*Specifies the distance from the spawner at which particles spawn, in meters.
*Optional
*Syntax: See [[Parsed random range]], default constant 1
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Deviation Mult''', or '''Length Mult''', which are multipliers for the respective tabled values of the spheroid volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

===Ring===
Defines a ring perpendicular to the spawner's orientation
====+Radius:====
*Specifies the radius of the ring
*Optional
*Syntax: float, default 1
====+On Edge:====
*Causes the particles to spawn just on the edge of the ring, rather than on the entire surface.
*Optional
*Syntax: boolean, default false
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Radius Mult''', which are multipliers for the respective tabled values of the ring volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

===Point===
Defines a single point only
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

==+Spawn Position Noise:==
*This setting can be used to add random noise (sampled over the particle source lifetime and a curve-defined seed) to the spawn position of particles.
*Optional
*Specified in ANL's (unfortunately poorly documented) [https://github.com/JTippetts/accidental-noise-library#expressions DSL].

==+Spawn Position Noise Scale:==
*A random range, which is used to scale the sampled spawn position noise vector.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Volume:==
*Defines a volume. The position sampled in this volume is used as the velocity vector for the spawned particles. I.e., a sphere as the velocity volume will let the particles randomly accelerate outwards evenly.
*''affected by orientation''
*Optional
*See [[#+Spawn Position Volume:]]

==+Velocity Volume Scale:==
*A random range, which is used to scale the velocity vector sampled from the velocity volume.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Noise:==
*This setting can be used to add random noise (sampled over the particle source lifetime and a curve-defined seed) to the velocity of particles.
*Optional
*Specified in ANL's (unfortunately poorly documented) [https://github.com/JTippetts/accidental-noise-library#expressions DSL].

==+Velocity Noise Scale:==
*A random range, which is used to scale the sampled velocity noise vector.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Direction Scale:==
*Sets whether the particles final velocity is scaled based on the direction of the velocity and the direction of the particle spawner.
*''affected by orientation''
*Optional, default ''None''
*Can be one of:
**''None'': No scaling is applied
**''Dot'': The velocity is scaled by the dot product between the velocity orientation and the spawner orientation. This means that particles flying in the same direction as the spawner points to will be faster.
**''Inverse Dot'': The velocity is scaled by the inverse dot product between the velocity orientation and the spawner orientation. This means that no matter the direction the particle velocity points to, all particles will have the same velocity in the direction of the spawner (assuming that the scalar velocity of all particles is equal).

==+Velocity From Position:==
*If set, will add the particles relative position to the spawn point multiplied by this random range as velocity. This will make the particles naturally spread outwards from the spawner. This is a random range; see [[Parsed random range]].
*Has no effect if no spawn position volume is tabled.
*Optional. Mututally exclusive with ''+Absolute Velocity From Position''.
*Syntax: See [[Parsed random range]]

==+Absolute Velocity From Position:==
*See [[#Velocity From Position:]], except that the position is normalized before applying the random range.

==+Velocity From Orientation:==
*If set, will add the spawners orientation multiplied by this random range as velocity. This will make the particles naturally move in the direction the spawner points to. This is a random range; see [[Parsed random range]].
*''affected by orientation''
*Optional.
*Syntax: See [[Parsed random range]]

==+Velocity Inherit:==
*If set, will add the parent's velocity multiplied by this random range as velocity for the particle. This will make the particles naturally move along with their spawning entity. This is a random range; see [[Parsed random range]].
*Optional. Mututally exclusive with ''+Absolute Velocity Inherit''.
*Syntax: See [[Parsed random range]]

==+Absolute Velocity Inherit:==
*See [[#+Velocity Inherit:]], except that the parent velocity is normalized before applying the random range.

==+Ignore Velocity Inherit If Parented:==
*If set, the velocity inherit will be forced to 0 if the effect has a valid parent that can be used for [[#+Remain local to parent:]]. Useful to create effects that want to use [[#+Remain local to parent:]], but have to work in scenarios where sometimes only velocity inherit is available.
*Optional, default false
*Syntax: Boolean

==$Particle Lifetime Curve:==
*A modular curve set.
*This modular curve set affects the spawned '''particle''' during its lifetime, and not to the spawner of the particles.
*Repeated occurrences of the following:
===+Input===
*One of:
**'''Lifetime''': representing the lifetime of the particle, not the spawner, from 0 to 1
**'''Age''': The age of the particle in seconds
**'''Radius''': The radius of the particle (not considering curve modifications)
**'''Velocity''': The velocity of the particle (not considering curve modification)
**'''Post-Curves Velocity''': The velocity of the particle when accounting for curves. Note that when this is queried for the '''Velocity''' output, it will be identical to the unmodified '''Velocity''' input.
===+Output===
*One of:
**'''Radius Mult''': Multiplies the radius of the particle
**'''Velocity Mult''', Multiplies the velocity of the particle
**'''Length Mult''', Multiplies the length of the particle. Only works if a length is tabled at all for this particle.
**'''Anim State''', sets the animation state of the particle, with 0.0 being the first frame of the animation, and 1.0 being the last. If this is used, all typical animation behavior (i.e. playing at a certain framerate over time) will be ignored.
**'''Light Radius Mult''', Multiplies the emission radius of a light source attached to the particle, if any
**'''Light Source Radius Mult''', Multiplies the source radius of a light source attached to the particle, if any
**'''Light Intensity Mult''', Multiplies the intensity of a light source attached to the particle, if any
**'''Light R Mult''', Multiplies the red component a light source attached to the particle, if any
**'''Light G Mult''', Multiplies the green component of a light source attached to the particle, if any
**'''Light B Mult''', Multiplies the blue component of a light source attached to the particle, if any
**'''Light Cone Angle Mult''', Multiplies the angle of the cone of a light source attached to the particle if it is tabled as a cone
**'''Light Cone Inner Angle Mult''', Multiplies the inner angle of the cone of a light source attached to the particle if it is tabled as a cone

===+Curve Name===
*The name of the curve which maps the input to the output
*Syntax: string, the curve name

==$Particle Source Curve:==
*A modular curve set. Repeated occurrences of the following:
===+Input===
*One of:
**'''Host Radius''': The radius of whatever object the particle spawner is attached to (such as the weapon spewing the particles, the ship being hit by a weapon having damage spew, etc).
**'''Host Velocity''': The velocity of whatever object the particle spawner is attached to.
**'''Trigger Radius''': The radius of whatever object caused the particles to spawn (such as the weapon hitting the ship, causing damage spew, etc).
**'''Trigger Velocity''': The velocity of whatever object caused the particles to spawn.
**'''Effects running''': The fraction of sub-effects of this effect that are still emitting particles.
**'''Spawntime Left''': The remaining time this sub-effect will emit particles for.
**'''Time Running''': The time this sub-effect has been emit particles for.
**'''Apparent Visual Size At Emitter''': The visual size in pixels, based on the current viewing position, that the average particle will have if spawned at the particle source. This does not consider the Radius Mult particle curve output, and does not consider position changes from a Spawn Position Volume.
**'''Total Particle Count''': The total number of particles currently present in the mission.
**'''Particle Usage Score''': The total number of particles currently present in the mission, divided by the current particle detail setting.

===+Output===
*One of:
**'''Particle Number Mult''': Multiplies the number of particles created each spawn
**'''Particle Frequency Mult''': Multiplies the frequency with which particles are spawned
**'''Radius Mult''': Multiplies the initial radius of spawned particles
**'''Length Mult''': Multiplies the initial length of spawned particles
**'''Lifetime Mult''': Multiplies the lifetime of spawned particles
**'''Velocity Volume Mult''': Multiplies the velocity obtained from the tabled velocity volume
**'''Velocity Inherit Mult''': Multiplies the velocity obtained from the tabled velocity inherit
**'''Velocity Position Inherit Mult''': Multiplies the velocity obtained from the tabled velocity from position
**'''Velocity Orientation Inherit Mult''': Multiplies the velocity obtained from the tabled velocity from orientation
===+Curve Name===
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
===+Random Scaling Factor:===
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
===+Random Translation:===
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
===+Wraparound:===
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

==$Trail Effect:==
*Adds a particle trail to this effect
*Optional, mutually exclusive with ''$Trail Inline Effect''
*Syntax: string, the name of a particle effect (must be defined previously)

==$Trail Inline Effect:==
*Adds a particle trail to this effect, defined inline
*It is not possible to define inline trails for inline trails due to parsing ambiguity. If you really need trails of trails of particles, use ''$Trail Effect:''
*Optional
*Syntax: Define a new particle just as if ''$Trail Inline Effect:'' had been ''$Effect''. It will not need a name to be specified after ''$Trail Inline Effect:''.

===$Continue Trail Effect:===
*Adds a new sub-effect to the trail
*Optional, can be repeated multiple times
See [[#$Continue Effect:]]

==$Continue Effect:==
*Adds a new sub-effect to this effect.
*This will then spawn multiple different types of particle effect if the parent effect is called. Similar to the legacy composite effect type.
*Optional, can be repeated multiple times
*Syntax: Define a new particle just as if ''$Continue Effect:'' had been ''$Effect''. It will not need a name to be specified after ''$Continue Effect:''.

==Sample==

<pre>
#Particle Effects

$Effect: smoke_exhaust
+Filename: particle_smoke01
+Bitmap Alignment: Random
+Radius: (0.1 0.5)
+Duration: Always
+Spawns per Second: 5
+Particle Count Per Spawn: (1 2)
+Direction: Aligned
+Velocity Offset: 0,5,-5
$Particle Source Curve:
+Input: Trigger Velocity
+Output: Radius Mult
+Curve Name: MB_SpeedCurve

#End
</pre>
[[Category:Tables]]

Particle Effects

2025-09-19T14:33:56Z

Lafiel: /* +Output */

{{SCP_table}}
{{TableVersionGit|2024-08-26|91a673ac586a57e8f7793f08985b6f17a7fd1aa7}}
{{Tables}}

{{Table250|
This table has been significantly refactored for FSO 25.0.
For documentation of the old table style, see [[Legacy Particle Effects]]
}}

Particle Effects is a SCP feature which allows to define custom particle effects that can be assigned to various engine properties.

This table is one of the [[Modular Tables]] and can be extended with xxx-part.tbm. This table type '''''does not have a main table''''' like the other types. All particle effects must be specified in modular tables. Currently there is no support for the usual ''+nocreate'' ability the other modular tables have but that will be added in the future. Parts of this documentation are written with with ''+nocreate'' in mind for when that is implemented.

=General Info=
*Begins with #Particle Effects
*Contains zero or more particle effect definitions
*Ends with #End

Particle effects are created by specifying a name and a type. The type dictates which values are valid and will be described below.

{{Table250|
*Particles as described here and as described in [[Legacy Particle Effects]] both share the '''*-part.tbm''' table, and can exist alongside oneanother within the same file.
*As such, it is not required to refactor legacy-style particles to the new format, unless the usage of newer features is desired.
}}

=$Effect:=
*Creates a new effect and specifies its name. The name must be at least one character long.
*Syntax: '''String'''

==+Filename:==
*Sets the filename of the animation that should be used.
*Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)

==+Animation Reversed:==
*If this is true, the animation specified will play in reverse.
*Defaults to false.
*Syntax: '''''Boolean'''''

==+Bitmap Alignment:==
*Sets how the bitmap is aligned
*Syntax: One of '''Screen Aligned''', '''Random''', or '''Default''' (uses the setting defined globally in [[Game_settings.tbl#$Randomize particle rotation:]])

==+Radius:==
*Sets the radius of the created particles. This is a random range; see [[Parsed random range]].
*Exactly one of ''+Radius'' and ''+Parent Radius Factor'' is required.
*Syntax: See [[Parsed random range]]

==+Parent Radius Factor:==
*Sets the radius to be a factor of the current size of the particle that spawned it. Only works when spawned as a trail particle effect of another particle. This is a random range; see [[Parsed random range]].
*Syntax: See [[Parsed random range]]

==+Length:==
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a random range; see [[Parsed random range]].
*This is optional
*Syntax: See [[Parsed random range]]

==+Lifetime:==
*Sets the life time of the particles. This is a random range; see [[Parsed random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional, but only one between +Lifetime and +Parent Lifetime Factor may be used.
*Syntax: See [[Parsed random range]], or the string ''<none>''

==+Parent Lifetime Factor:==
*Sets the lifetime to be a factor of the remaining lifetime of the particle that spawned it. Only works when spawned as a trail particle effect of another particle. This is a random range; see [[Parsed random range]].
*This is optional, but only one between +Lifetime and +Parent Lifetime Factor may be used.
*Syntax: See [[Parsed random range]]

==+Remain local to parent:==
*If this is true, the effect will be 'parented' to its spawner, and will move with it, inheriting all changes to the spawner's position and orientation. Very useful for some types of muzzle effect.
*Defaults to false.
*Syntax: '''''Boolean'''''

==+Duration:==
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[Parsed random range]].

==+Delay:==
*Specifies after how much time after the effect is triggered the effect starts creating particles.
*This is optional
*Syntax: See [[Parsed random range]]

==+Spawns per second:==
*Specifies how many times per seconds particles will spawn from this effect. If this is not specified then the effect is triggered every frame. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*Batches of particles spawned at different points during a frame will be spawned at the correct positions along a moving spawner entity's trajectory, with millisecond precision, rather than all 'clumping' at the spawner's final position for that frame. This works for particles spawned from objects (like ships and weapons), and ones spawned from other particles (as with a $Trail effect), but does not currently work for particles spawned from beams.
*This is optional
*Syntax: ''number''. Must be greater than 0.

==+Particle Count Per Spawn:==
*Sets the amount of particles created every time this effect spawns new particles. This is a [[Parsed random range]].
*This setting is multiplicative with ''+Spawns per second:''. The former defines how often things are spawned, while ''+Particle Count Per Spawn:'' defined how many individual particles are spawned each time.
*Syntax: See [[Parsed random range]]

==+Direction:==
*Sets the direction of the particle spawner. This influences many following options, which will be marked with ''affected by orientation''. Can be one of:
**''Aligned'': The direction of the particle spawner will be aligned by whatever created it. This could be the direction a muzzle is facing, a weapon is flying, a beam is shooting, etc.
**''HitNormal'': The direction of the particle spawner will be set to the normal vector of the event that spawns the particle. This can be something like the normal vector of a weapon impact. If no normal vector exists for a given event, ''Aligned'' will be used instead.
**''Reflected'': The direction of the particle spawner will be set to the ''Aligned'' direction after it is reflected off using the normal vector. This is a good way of simulating armor deflecting a shot. If no normal vector is present in the current event, it'll be set to ''Aligned'' instead.
**''Reverse'': The reverse of the ''Aligned'' vector
*Optional
*Syntax: '''String''', one of the strings specified above

==+Position Offset:==
*Offsets the position of the particle source relative to the spawner. Positive Z means "forward".
*''affected by orientation''
*For effects spawned from sources will a full orientation, such as ships (including primary or secondary muzzle effects) and weapons (including hit effects), all three dimensions will work correctly.
*For effects spawned from sources that just have a defined forward vector, such as particles (as with trail effects) or beams, the X and Y axes will have no influence.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

==+Velocity Offset:==
*Adds a constant velocity to particles spawned by this spawner. Positive Z means "forward".
*''affected by orientation''
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

==+Spawn Position Volume:==
*Defines the volume around the particle effect spawner in which the particles will spawn (randomly distributed within the volume).
*''affected by orientation''
*Optional
*Syntax: One of the following types

===Spheroid===
====+Radius:====
*Specifies the radius of the volume
*Optional
*Syntax: float, default 1
====+Bias:====
*Causes the particles to spawn more frequently near the edges or near the center. Values greater than 1 bias the particles toward the center, less than 1 biases them towards the edge.
*Optional
*Syntax: float, default 1
====+Stretch:====
*'Stretches' or squashes the spherical volume into an ellipsoid. Values greater than 1 stretch it, less than 1 squashes it.
*Optional
*Syntax: float, default 1
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]].
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Radius Mult''', '''Bias Mult''', or '''Stretch Mult''', which are multipliers for the respective tabled values of the spheroid volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true
===Cone===
====+Deviation:====
*Specifies the standard deviation by how much an average particle will deviate from the given spawner direction in degrees.
*Exactly one of ''+Deviation'' or ''+Deviation Profile'' is required
*Syntax: float
====+Deviation Profile:====
*Specifies the deviation of a particle from the given spawner direction as a random range '''in radians'''.
*Syntax: See [[Parsed random range]]

====+Length:====
*Specifies the distance from the spawner at which particles spawn, in meters.
*Optional
*Syntax: See [[Parsed random range]], default constant 1
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Deviation Mult''', or '''Length Mult''', which are multipliers for the respective tabled values of the spheroid volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

===Ring===
Defines a ring perpendicular to the spawner's orientation
====+Radius:====
*Specifies the radius of the ring
*Optional
*Syntax: float, default 1
====+On Edge:====
*Causes the particles to spawn just on the edge of the ring, rather than on the entire surface.
*Optional
*Syntax: boolean, default false
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Radius Mult''', which are multipliers for the respective tabled values of the ring volume. '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

===Point===
Defines a single point only
====+Volume Position Offset:====
*Offsets this volume by a fixed offset.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====+Volume Point Towards:====
*Rotates this volume to point towards a specific point defined in the local spawner's orientation.
*Optional
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively
====$Volume Curve:====
*A modular curve set. Repeated occurrences of the following:
=====+Input=====
For possible inputs see [[#$Particle Source Curve:|the inputs for particle source curves]]
Additionally, '''Fraction Particles Spawned''', representing the how many particles have been spawned in this single spawn event, from 0 to 1.
=====+Output=====
*One of: '''Offset Rotate Around Fvec''', which rotates the ''+Volume Position Offset:'' around the spawner's orientation. '''Point To Rotate Around Fvec''', which rotates the ''+Volume Point Towards:'' around the spawner's orientation.

=====+Curve Name=====
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
=====+Random Scaling Factor:=====
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Random Translation:=====
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
=====+Wraparound:=====
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

==+Spawn Position Noise:==
*This setting can be used to add random noise (sampled over the particle source lifetime and a curve-defined seed) to the spawn position of particles.
*Optional
*Specified in ANL's (unfortunately poorly documented) [https://github.com/JTippetts/accidental-noise-library#expressions DSL].

==+Spawn Position Noise Scale:==
*A random range, which is used to scale the sampled spawn position noise vector.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Volume:==
*Defines a volume. The position sampled in this volume is used as the velocity vector for the spawned particles. I.e., a sphere as the velocity volume will let the particles randomly accelerate outwards evenly.
*''affected by orientation''
*Optional
*See [[#+Spawn Position Volume:]]

==+Velocity Volume Scale:==
*A random range, which is used to scale the velocity vector sampled from the velocity volume.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Noise:==
*This setting can be used to add random noise (sampled over the particle source lifetime and a curve-defined seed) to the velocity of particles.
*Optional
*Specified in ANL's (unfortunately poorly documented) [https://github.com/JTippetts/accidental-noise-library#expressions DSL].

==+Velocity Noise Scale:==
*A random range, which is used to scale the sampled velocity noise vector.
*Optional
*Syntax: See [[Parsed random range]], default constant 1

==+Velocity Direction Scale:==
*Sets whether the particles final velocity is scaled based on the direction of the velocity and the direction of the particle spawner.
*''affected by orientation''
*Optional, default ''None''
*Can be one of:
**''None'': No scaling is applied
**''Dot'': The velocity is scaled by the dot product between the velocity orientation and the spawner orientation. This means that particles flying in the same direction as the spawner points to will be faster.
**''Inverse Dot'': The velocity is scaled by the inverse dot product between the velocity orientation and the spawner orientation. This means that no matter the direction the particle velocity points to, all particles will have the same velocity in the direction of the spawner (assuming that the scalar velocity of all particles is equal).

==+Velocity From Position:==
*If set, will add the particles relative position to the spawn point multiplied by this random range as velocity. This will make the particles naturally spread outwards from the spawner. This is a random range; see [[Parsed random range]].
*Has no effect if no spawn position volume is tabled.
*Optional. Mututally exclusive with ''+Absolute Velocity From Position''.
*Syntax: See [[Parsed random range]]

==+Absolute Velocity From Position:==
*See [[#Velocity From Position:]], except that the position is normalized before applying the random range.

==+Velocity From Orientation:==
*If set, will add the spawners orientation multiplied by this random range as velocity. This will make the particles naturally move in the direction the spawner points to. This is a random range; see [[Parsed random range]].
*''affected by orientation''
*Optional.
*Syntax: See [[Parsed random range]]

==+Velocity Inherit:==
*If set, will add the parent's velocity multiplied by this random range as velocity for the particle. This will make the particles naturally move along with their spawning entity. This is a random range; see [[Parsed random range]].
*Optional. Mututally exclusive with ''+Absolute Velocity Inherit''.
*Syntax: See [[Parsed random range]]

==+Absolute Velocity Inherit:==
*See [[#+Velocity Inherit:]], except that the parent velocity is normalized before applying the random range.

==+Ignore Velocity Inherit If Parented:==
*If set, the velocity inherit will be forced to 0 if the effect has a valid parent that can be used for [[#+Remain local to parent:]]. Useful to create effects that want to use [[#+Remain local to parent:]], but have to work in scenarios where sometimes only velocity inherit is available.
*Optional, default false
*Syntax: Boolean

==$Particle Lifetime Curve:==
*A modular curve set.
*This modular curve set affects the spawned '''particle''' during its lifetime, and not to the spawner of the particles.
*Repeated occurrences of the following:
===+Input===
*One of:
**'''Lifetime''': representing the lifetime of the particle, not the spawner, from 0 to 1
**'''Age''': The age of the particle in seconds
**'''Radius''': The radius of the particle (not considering curve modifications)
**'''Velocity''': The velocity of the particle (not considering curve modification)
**'''Post-Curves Velocity''': The velocity of the particle when accounting for curves. Note that when this is queried for the '''Velocity''' output, it will be identical to the unmodified '''Velocity''' input.
===+Output===
*One of:
**'''Radius Mult''': Multiplies the radius of the particle
**'''Velocity Mult''', Multiplies the velocity of the particle
**'''Length Mult''', Multiplies the length of the particle. Only works if a length is tabled at all for this particle.
**'''Anim State''', sets the animation state of the particle, with 0.0 being the first frame of the animation, and 1.0 being the last. If this is used, all typical animation behavior (i.e. playing at a certain framerate over time) will be ignored.
**'''Light Radius Mult''', Multiplies the emission radius of a light source attached to the particle, if any
**'''Light Source Radius Mult''', Multiplies the source radius of a light source attached to the particle, if any
**'''Light Intensity Mult''', Multiplies the intensity of a light source attached to the particle, if any
**'''Light R Mult''', Multiplies the red component a light source attached to the particle, if any
**'''Light G Mult''', Multiplies the green component of a light source attached to the particle, if any
**'''Light B Mult''', Multiplies the blue component of a light source attached to the particle, if any
**'''Light Cone Angle Mult''', Multiplies the angle of the cone of a light source attached to the particle if it is tabled as a cone
**'''Light Cone Inner Angle Mult''', Multiplies the inner angle of the cone of a light source attached to the particle if it is tabled as a cone

===+Curve Name===
*The name of the curve which maps the input to the output
*Syntax: string, the curve name

==$Particle Source Curve:==
*A modular curve set. Repeated occurrences of the following:
===+Input===
*One of:
**'''Host Radius''': The radius of whatever object the particle spawner is attached to (such as the weapon spewing the particles, the ship being hit by a weapon having damage spew, etc).
**'''Host Velocity''': The velocity of whatever object the particle spawner is attached to.
**'''Trigger Radius''': The radius of whatever object caused the particles to spawn (such as the weapon hitting the ship, causing damage spew, etc).
**'''Trigger Velocity''': The velocity of whatever object caused the particles to spawn.
**'''Effects running''': The fraction of sub-effects of this effect that are still emitting particles.
**'''Spawntime Left''': The remaining time this sub-effect will emit particles for.
**'''Time Running''': The time this sub-effect has been emit particles for.
**'''Apparent Visual Size At Emitter''': The visual size in pixels, based on the current viewing position, that the average particle will have if spawned at the particle source. This does not consider the Radius Mult particle curve output, and does not consider position changes from a Spawn Position Volume.
**'''Total Particle Count''': The total number of particles currently present in the mission.
**'''Particle Usage Score''': The total number of particles currently present in the mission, divided by the current particle detail setting.

===+Output===
*One of:
**'''Particle Number Mult''': Multiplies the number of particles created each spawn
**'''Particle Frequency Mult''': Multiplies the frequency with which particles are spawned
**'''Radius Mult''': Multiplies the initial radius of spawned particles
**'''Length Mult''': Multiplies the initial length of spawned particles
**'''Lifetime Mult''': Multiplies the lifetime of spawned particles
**'''Velocity Volume Mult''': Multiplies the velocity obtained from the tabled velocity volume
**'''Velocity Inherit Mult''': Multiplies the velocity obtained from the tabled velocity inherit
**'''Velocity Position Inherit Mult''': Multiplies the velocity obtained from the tabled velocity from position
**'''Velocity Orientation Inherit Mult''': Multiplies the velocity obtained from the tabled velocity from orientation
===+Curve Name===
*The name of the curve which maps the input to the output
*Syntax: string, the curve name
===+Random Scaling Factor:===
*A random range, which is used to divide the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
===+Random Translation:===
*A random range, which is used to offset the input by the sampled value.
*Optional
*Syntax: See [[Parsed random range]]
===+Wraparound:===
*If set, values outside the defined range of the curve will be wrapped around instead of clipped.
*Optional
*Syntax: boolean, default true

==$Trail Effect:==
*Adds a particle trail to this effect
*Optional, mutually exclusive with ''$Trail Inline Effect''
*Syntax: string, the name of a particle effect (must be defined previously)

==$Trail Inline Effect:==
*Adds a particle trail to this effect, defined inline
*It is not possible to define inline trails for inline trails due to parsing ambiguity. If you really need trails of trails of particles, use ''$Trail Effect:''
*Optional
*Syntax: Define a new particle just as if ''$Trail Inline Effect:'' had been ''$Effect''. It will not need a name to be specified after ''$Trail Inline Effect:''.

===$Continue Trail Effect:===
*Adds a new sub-effect to the trail
*Optional, can be repeated multiple times
See [[#$Continue Effect:]]

==$Continue Effect:==
*Adds a new sub-effect to this effect.
*This will then spawn multiple different types of particle effect if the parent effect is called. Similar to the legacy composite effect type.
*Optional, can be repeated multiple times
*Syntax: Define a new particle just as if ''$Continue Effect:'' had been ''$Effect''. It will not need a name to be specified after ''$Continue Effect:''.

==Sample==

<pre>
#Particle Effects

$Effect: smoke_exhaust
+Filename: particle_smoke01
+Bitmap Alignment: Random
+Radius: (0.1 0.5)
+Duration: Always
+Spawns per Second: 5
+Particle Count Per Spawn: (1 2)
+Direction: Aligned
+Velocity Offset: 0,5,-5
$Particle Source Curve:
+Input: Trigger Velocity
+Output: Radius Mult
+Curve Name: MB_SpeedCurve

#End
</pre>
[[Category:Tables]]

Weapons.tbl

2025-07-09T08:53:46Z

Lafiel: /* $Impact Explosion: */

{{TableVersionGit|2024-12-10|228fd17}}
{{Tables}}
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

==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 primary weapons''', as well '''flak weapons'''. Traditionally, '''beam weapons''' are also defined in this section.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***Defines '''beam weapons'''. Traditionally they appear in the primary weapon section, but this is technically their proper place.
**<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).

NOTE: Beam weapons defined in the primary section will receive the WP_LASER subtype, and beam weapons defined in the beam section will receive the WP_BEAM subtype. They will behave identically in most respects, with the only in-game difference being a somewhat larger and asymmetrical impact explosion effect for WP_BEAM. In scripts, beams will return true for '''isLaser()''' if they have the WP_LASER subtype, and false if they have the WP_BEAM subtype. (They will always return true for '''isBeam()'''.)

==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]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in weapons.tbl or in earlier parsed *-wep.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

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

===$Turret Name:===
{{Table222|
*Renames a turret to this if this is the first weapon on a turret.
*Syntax: XSTR('''''"String"''''', -1)}}

===$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. Only valid if a tech model is defined
*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.
}}
{{Table38|
*Note: It's no longer required that the ship actually have external models enabled (whether or not this weapon has one defined) for the spin up delay to occur.
}}

===$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 Head-on Bitmap:====
{{Table220|
Defines another laser graphic file to be used and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@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 Glow Head-on Bitmap:====
{{Table220|
Defines another graphic file to be used for the laser glow and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Head-on Transition Angle:====
{{Table220|
Overrides the angle in degrees from the front (or back) that the head-on transition crossfade is at exactly a 50/50 blend.

Syntax: '''''Float''''', degrees
Default: Calculated from the ratio of the laser's length to its average radius}}

====@Laser Head-on Transition Rate:====
{{Table220|
Defines how quickly the head-on transition fades from one bitmap to the other. Greater than 20 is an instant switch with no blending.

Syntax: '''''Float'''''
Default: 2}}

====@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
{{Table240|
===@Laser Length Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's length over time.
*The life of the weapon (0-1) is X, the length multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Head Radius:====
Defines the radius 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.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser head's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters

====@Laser Tail Radius:====
Defines the radius 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.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser tail's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters
{{Table240|
===@Laser Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's radius values (both head and tail) over time.
*The life of the weapon (0-1) is X, the radius multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Glow Length Scale:====
Scaling factor for glow bitmap along the length axis, relative to the length of the main laser bitmap. Default is 2.0.

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

====@Laser Glow Head Scale:====
Scaling factor for the radius of the glow bitmap at its head, relative to the radius of the main laser bitmap's head. Default is 2.3.
*Note that laser length is calculated in an odd way: the head and tail are treated as ''spheres'', with the length being the distance between the centers of those spheres, so the actual length of a laser (or laser glow) is length + head radius + tail radius.
*This can result in unintuitive behavior if glow length scaling is set differently from head or tail scaling.
*However, as long as length, head, and tail glow scale are all set to the same value, the glow bitmap will be scaled up while maintaining the same aspect ratio as the laser.
Syntax: '''''Float'''''

====@Laser Glow Tail Scale:====
Scaling factor for the radius of the glow bitmap at its tail, relative to the radius of the main laser bitmap's tail. Default is 2.3.
*See note in head scale entry regarding unintuitive behavior.
Syntax: '''''Float'''''

====@Laser Position Offset:====
Moves the laser relative to its collision point by multiples of the laser length, along any of the three axes. For example, a value of -1.0 along the Z axis will move the laser backward so that the visible laser no longer extends forward from the collision point, but backward, with the collision point at the head rather than the tail. A value of 1.0 along the X axis will move the laser one laser-length to the right.
*Important note: the X and Y axes are relative to the orientation of the weapon, which normally seems to match the orientation of the firing ship, but which is not guaranteed to remain stable. If the weapon rotates, the orientation of the offset will rotate with it.
Syntax: '''''Vector'''''

====@Laser Min Pixel Size:====
If this is set to a non-zero value, the laser will always be at least the specified number of pixels wide, no matter how far away it is. Defaults to the $Minimum Pixel Size Lasers: value in Game settings.tbl, or to 0 if that is not set.

Syntax: '''''Integer'''''

{{Table240|
===@Laser Opacity Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's opacity over time.
*The life of the weapon (0-1) is X, the opacity is Y, with 0 being invisible and 1 being typical opacity.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Light color:===
{{Table222|
*Sets the color of light cast by the weapon.
*Syntax: '''''Color''''', red, green, blue respectively, from 0 to 255
*Default value: If not set, the color is white for weapons with models, or based on the laser colors otherwise }}

===$Light radius:===
{{Table222|
*Sets the maximum distance light cast by the weapon will reach. Increasing this will tend to make it appear brighter near it's center
*Syntax: '''''float''''', any positive value
*Default value: The defaults for different weapon types are set in [[Lighting_Profiles.tbl]]}}

===$Light intensity:===
{{Table222|
*Acts as a multiplier to the brightness of the light cast by the weapon. This changes the brightness without affecting the radius.
*Syntax: '''''float''''', any positive value
*Default value: 1}}

===$Collision Radius Override:===
{{Table202|
*Weapon - weapon collisions are treated as two spheres, where a laser's sphere's radius is equal to its Head Radius, and a missile's is the radius of its associated model (possibly doubled). Using this will override either of those values.
*If used on a beam it will override its collision radius as well, instead of using the widest section.
*NOTE: If the weapon is interceptable, such as a bomb or has been given hitpoints, this value will ''still'' be doubled, unless the "no radius doubling" flag is used.
*Syntax: '''''Float''''', meters}}

===$Mass:===
*Scales the kinetic effect this weapon has on its target. With higher mass imparting a stronger effect.
*The eventual kinetic effect is also multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. This is also true for the intesnity of the "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

====+Max Delay:====
{{Table373|
*Defines the maximum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Min Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

====+Min Delay:====
{{Table373|
*Defines the minimum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Max Delay: to have any effect.
*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 approximately 5.88 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*The exact factor to multiply by is 100/17, or one 'pulse' of damage every 170 seconds. The generally used wisdom of 5.5 times may have been generally accurate before beam damage was made continuous and frame-rate independent, but is now out of date information.
*Syntax: '''''Float''''', damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)

===$Damage Time:===
{{Table373|
*This sets a time from the end of the weapons lifetime that damage will start to attenuate at. '''''Example: Weapon lifetime is 2.0 seconds and the desired effect is to attenuate after 0.5 seconds have passed, set this to 1.5 seconds.'''''
*Syntax: '''''Float''''', seconds. Defaults to 0.0.
**Note: If neither +Min Damage: nor +Max Damage: is set, the damage will always attenuate to zero at max range.
***If both +Min Damage: and +Max Damage: are set, both are defaulted to 0.0 and damage will be attenuated to zero.}}

====+Attenuation Damage:====
{{Table373|
*This sets the damage a weapon will attenuate to after reaching $Damage Time:.
*Syntax: '''''Float''''', damage.}}

====+Min Damage:====
{{Table373|
*This sets the lowest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

====+Max Damage:====
{{Table373|
*This sets the highest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

===$Angle of Incidence Damage Multiplier:===
{{Table212|
*Causes the weapon's damage to be multiplied by these factors depending on the angle of incidence.
*It is ''not'' linear, it is based on the sine of the angle to the surface. If the factors are 1x for minimum, and 2x for maximum, at an angle of 45° the multiplier is 1.707x, for instance.
====+Min:====
*The damage multiplier at a perfectly glancing hit, parallel to the surface (although not technically possible).
*Syntax: '''''Float'''''
====+Max:====
*The damage multiplier when hit straight on, perpendicular to the surface.
*Syntax: '''''Float'''''}}
{{Table240|
===$Damage Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's damage over time.
*The life of the weapon (0-1) is X, the damage multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$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}}

===$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 traveling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in 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]]}}

===$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
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*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)
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters
{{Table240|
===$Shockwave Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the shockwave's radius over time. This will ''ignore'' $Shockwave Speed for the purposes of determining the size of the shockwave over time, however $Outer radius / $Shockwave Speed will still be the total time that the shockwave lasts. Even if the multiplier goes beyond 1, the shockwave still cannot hit or damage targets beyond its $Outer radius.
*The life of the shockwave (0-1) is X, the outer radius multiplier is Y. This will entirely determine how the shockwave grows and shrinks over time.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that any area-effect damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated. Random, if left undefined.
*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}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$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:'''''}}
{{Table202|
*'''''+Shockwave sound:'''''}}

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

{{Table250|
===$Launch Curve:===
*A set of [[modular curve]]s that controls the firing behavior of the weapon. These curves will have no effect on beams.
*Available inputs:
**'''Num Firepoints''': the number of barrels in the bank firing the weapon
**'''Distance to Target'''
**'''Target Radius'''
*Available outputs:
**'''Fire Wait Mult'''
**'''Shots Mult'''
**'''Burst Shots Mult'''
**'''Burst Delay Mult'''
**'''Velocity Mult'''
**'''Life Mult'''
**'''Failure Rate Mult'''
**'''FoF Mult'''

===$Lifetime Curve:===
*A set of [[modular curve]]s, dealing with changes to the weapon during its existence. These curves will have no effect on beams.
*Available inputs:
**'''Lifetime''': starts at 0.0 when the weapon is created, ends at 1.0 when it runs out of life
**'''Age''': how long the weapon has existed, in seconds
**'''Base Velocity''': the weapon's velocity. This accounts for launch curves, but does NOT account for other lifetime curves, so as to avoid a feedback loop.
**'''Base Damage''': the weapon's damage. This accounts for launch curves, but does NOT account for hit curves, so as to avoid a feedback loop.
**'''Max Hitpoints'''
**'''Current Hitpoints'''
**'''Hitpoints Fraction''': the weapon's current hitpoints divided by its maximum hitpoints
**'''Parent Radius''': radius of the ship ultimately responsible for firing the weapon
**'''Viewing Angle''': direction from which the player is looking at the weapon. -1.0 means directly head-on, 0.0 means directly from the side, and 1.0 means directly from the rear.
**'''Apparent Size''': the weapon's radius as a fraction of the screen height
*Available outputs:
**'''Laser Length Mult'''
**'''Laser Radius Mult'''
**'''Laser Head Radius Mult'''
**'''Laser Tail Radius Mult'''
**'''Laser Offset X Mult'''
**'''Laser Offset Y Mult'''
**'''Laser Offset Z Mult'''
**'''Laser Headon Transition Angle Mult'''
**'''Laser Headon Transition Rate Mult'''
**'''Laser Animation State''': sets the animation state of the laser, with 0.0 being the first frame of the animation, and 1.0 being the last. If this is used, all typical animation behavior (i.e. playing at a certain framerate over time) will be ignored.
**'''Laser Animation State Add''': adds a certain number of frames to the laser's animation state. Does not disable typical animation behavior on its own.
**'''Laser Alpha Mult'''
**'''Laser Bitmap R Mult'''
**'''Laser Bitmap G Mult'''
**'''Laser Bitmap B Mult'''
**'''Laser Glow R Mult'''
**'''Laser Glow G Mult'''
**'''Laser Glow B Mult'''
**'''Light Intensity Mult'''
**'''Light Radius Mult'''
**'''Light R Mult'''
**'''Light G Mult'''
**'''Light B Mult'''
**'''Detonation Radius Mult'''
**'''Turn Rate Mult'''
**'''Child Spawn Rate Mult'''
**'''Child Spawn Count Mult'''

===$Hit Curve:===
*A set of [[modular curve]]s, controlling how the weapon affects things it hits. These curves will have no effect on beams.
*Available inputs:
**'''All of the Lifetime Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
**'''Dot''': the angle at which the weapon has struck the target surface. 1.0 means a direct hit, perpendicular to the target surface. 0.0 would mean a hit exactly parallel to the surface.
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''

===$Beam Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''Beam Lifetime''': the beam's lifetime, from 0.0 to 1.0, not including the warmup or warmdown phases
**'''Beam Age''': in seconds
**'''Beam Total Life''': how long the beam is capable of lasting, not including warmup or warmdown
**'''Warmup Lifetime''': lifetime of the warmup phase, starting at 0.0 and ending at 1.0 when the beam fires
**'''Warmdown Lifetime'''
**'''Warmdown Age''': time elapsed since warmdown started, in seconds
**'''Parent Radius'''
*Available outputs:
**'''Beam Width Mult''': does NOT disable tabled flickering or shrinking if set
**'''Beam Alpha Mult'''
**'''Beam Anim State''': behaves like laser anim state
**'''Muzzle Glow Radius Mult''': if this is set, the typical hardcoded muzzle glow size behaviors are disabled
**'''Muzzle Glow Alpha Mult''': if this is set, the typical hardcoded muzzle glow fading behaviors are disabled
**'''Muzzle Glow Anim State''': behaves like laser anim state
**'''Move End Position by Target Velocity''': if the beam is slashing at a target, the beam's end position will be offset by the target's velocity (at time of beam creation) times this output value

===$Beam Hit Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''All of the Beam Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''
}}

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turreted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Autoaim FOV:===
{{Table224|
'''This option is exclusive to primaries.'''
*Defines if the weapon will have auto-aim and what the FOV of the auto-aim is.
*Syntax: '''''Float'''''}}

===$Homing:===
'''This option is exclusive to secondaries.'''
{{Table212|'''This option may now be applied to primaries'''. They may only use heat seeking. For optimal results the "no homing speed ramp" flag may be used.}}

Defines if the bolts/missiles in question is homing

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 quickly the missile can turn. Ostensibly the number of seconds it takes the missile to do a 360 degree circle at full turn speed, but for complicated reasons this is only true if [[Game_settings.tbl#.2BAI_respect_tabled_turn_time_and_rotdamp|AI respect tabled turn time and rotdamp]] is enabled.
**Syntax: '''''Float''''', seconds

===='''+Turning Acceleration Time:'''====
{{Table202|
Determines how quickly the missile reaches its maximum turn speed.
*Note: Requires [[Game_settings.tbl#.24AI_use_framerate_independent_turning:|$AI use framerate independent turning]] in game_settings.tbl
**Syntax: '''''Float''''', seconds}}
{{Table240|
===+Turn Rate Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's turn rate over time.
*The life of the weapon (0-1) is X, the turn rate multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===='''+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. They will continue to home on targets outside their view cone, but will take a continuous lifetime penalty every second their target is outside this cone.}}

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

===='''+Lock FOV:'''====
{{Table234|
Defines the width of the cone within which the missile is capable of achieving a lock, in degrees. Only applies to aspect seekers.
*Syntax: '''''Float''''', default (approximately): 63.57666}}

===='''+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.}}

===='''+Target Lock Restriction:'''====
{{Table202|
Defines if the missile can lock onto ships besides the current target
*Syntax: '''''String''''', name of the behavior, default is ''current target only'';.
*''Current target only'' As normal, can only acquire locks on the targeted ship
*''Any target'' Missile will lock on any valid target. Missile locking is still disabled in certain cases, such as when a friendly is the player's target
*''Current target, any subsystem'' Targeting is restricted to the current ship, but will pick turrets and subsystems on that ship. }}

===='''+Independent Seekers:'''====
{{Table202|
Defines the ability for a missile to target multiple objects at once.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Target Lock Objecttypes:'''====
{{Table220|
Defines what type of object can be locked on with this weapon
*Syntax: '''''String''''', name of the object type, default is ''ships''
*''ships'' Will target only ships
*''bombs'' Will target bombs and targetable missiles }}

===='''+Trigger Hold:'''====
{{Table202|
Defines the ability to hold the trigger to lock and release to fire.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Reset On Launch:'''====
{{Table202|
Defines the ability for locks to reset upon missiles being fired.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Max Seekers Per Target:'''====
{{Table202|
Defines the maximum number of seekers that can target a single object.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Max Active Seekers:'''====
{{Table202|
Defines the maximum number of total seekers for the weapon to have.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Ship Types:'''====
{{Table202|
Defines the ship types that this missile can target. In order for a ship to be targetable it must be able to match one of the listed types, if some of the below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship types.}}

===='''+Ship Classes:'''====
{{Table202|
Defines the ship classes that this missile can target. In order for a ship to be targetable it must be able to match one of the listed classes, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship classes.}}

===='''+Species:'''====
{{Table202|
Defines the species whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed Species, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', species.}}

===='''+IFFs:'''====
{{Table202|
Defines the IFF's whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed IFFs, if some of the above lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', IFFs.}}

===$Homing Auto-Target Method:===
{{Table214|
*If this weapon needs to acquire a target on its own, such as a heatseeker losing its target or having the "untargeted heatseeker" flag, this determines how it should do so. Options are:
*'''CLOSEST''', the weapon will acquire the nearest target that it is able.
*'''RANDOM''', the weapon will acquire a random target from those available.
}}

===$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.
*Swarm will negatively affect the missile's ability to hit its target and will not lead its target even with [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] defined unless [[Game_settings.tbl#.24Swarmers_Lead_Targets:|$Swarmers Lead Targets]] is enabled.
*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)}}

===$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 traveling 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 parses but doesn't use the value, and prints a warning in the log. This feature has subsequently been reimplemented, see $Free Flight Speed Factor: below}}
}}

===$Free Flight Speed Factor:===
{{Table202|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
}}

===$Gravity Const:===
{{Table224|
*If the mission has gravity, this is the multiplier applied to acceleration from gravity on the weapon.
*AI will lead for ballistic trajectories, and this may affect their range as they will not fire unless they can successfully make a ballistic path to their target.
*'''Homing weapons are unaffected by gravity no matter what'''.
*Syntax: '''''Float'''''
**Default: 0}}

===$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]]

===$CockpitLaunchSnd:===
{{Table232|
*Corresponding sound effect when the weapon is launched from the player's ship, allowing use of 2d stereo sounds.
*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

{{Table214|
===$AmbientSnd:===
*The sound this weapon passively emits in 3d space. The weapon version of [[Ships.tbl#.24EngineSnd:|EngineSnd]] for ships.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$StartFiringSnd:===
*The sound that plays when the user presses the trigger down while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$LoopFiringSnd:===
*The sound that plays while the user is firing the weapon and is holding the trigger down.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$EndFiringSnd:===
*The sound that plays when the user releases the trigger while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$TrackingSnd===
{{Table3615|
*The looping sound played when the player is tracking a target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when the player has locked onto their target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played while the player has this weapon 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 frequency that weapons are loaded to the ship
*Syntax: '''''Float''''', How many times per second the weapons are loaded.
**Example: 2.0 will reload every half second. 0.1 will load every ten seconds.

===$Rearm Ammo Increment:===
{{Table38|
*Defines how many missiles or how much ballistic ammo is loaded per load sound.
*Syntax: '''''Integer''''', how many bullets or missiles are loaded. Default 4 for missiles, 100 for ballistic primaries.}}

===+Weapon Range:===
*If set, the AI will use this value or the result of weapon lifetime * velocity as the weapon's effective range, whichever is lower. This also affects the [[Hud_gauges.tbl#Lead_Indicator|Lead Indicator]]
*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}}

===+Weapon Optimum Range:===
{{Table214|
*AI fightercraft will attempt to close the distance to their target while they are outside of this range and using this weapon as their currently equipped primary.
*Syntax: '''''Float''''', meters}}

===$Pierce Objects:===
{{Table212|
*Causes the weapon to penetrate the objects impacted and not be destroyed.
*Syntax: '''''Boolean'''''
====+Spawn Children On Pierce:====
*Will spawn the weapons children on each hit, not just when it eventually gets destroyed through lifetime
*Syntax: '''''Boolean'''''}}

===$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
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
**Larger numbers above 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Smaller numbers below 1 cause it to fade away quickly at first, and then slow down for most of its life.
**Syntax: '''''Float''''', positive}}
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
{{Table202|
*'''+Spread:'''
**Causes the trail points to diffuse and drift apart at this speed over time.
**Syntax: '''''Float''''', meters per second}}
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table212|
*'''+Bitmap Stretch:'''
**Multiplies how far the bitmap is stretched over each trail segment.
**Syntax: '''''Float'''''}}
{{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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for impacts of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!
}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
{{Table190|
*A weapon_expl.tbl entry is no longer required.}}
*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 impact explosion if it hits the shield, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Shield Impact Effect Radius:===
{{Table250|
*Radius of the visual effect displayed on the shield mesh when this weapon hits the shield, see also [[Ships.tbl#.2BMax Shield Impact Effect Radius:]].
*Syntax: '''''Float''''', meters}}

===$Dinky Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for Dinky (not armed) explosions of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Dinky Impact Explosion'' and ''$Dinky Impact Explosion Radius'' are not valid options!
}}

===$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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for piercing impacts.
*Syntax: '''String''', the particle effect name
*If this option is specified then piercing impact options below are not valid!
}}

===$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.

===$Conditional Impact:===
{{Table242|
*Defines an impact effect that will play for this weapon only under certain conditions.
*May be defined any number of times.
*Currently only works for targets that are ships or weapons. Impacts against weapons are not considered to have a hit angle.
*All conditional impacts whose requirements are met will play.
*Non-conditional impact effects, the ones defined above, will only play if no conditional impacts' requirements are met.
*'''+Armor Type:'''
**Name of armor type the target must have in order for this impact to play. Shields can have their own armor types. (Subsystems can as well, but at present this system will not detect that.)
**Syntax: ''''''String'''''', name of armor type in [[armor.tbl]]
*'''+Min Health Threshold:'''
**Fraction of target health below which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Max Health Threshold:'''
**Fraction of target health above which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 1.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Min Angle Threshold:'''
**Hit angle -- that is, the angle measuring how 'straight on' you're hitting the target surface -- below which impact will not play.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', degrees
*'''+Max Angle Threshold:'''
**Hit angle above which impact will not play.
**Optional; defaults to 180.0.
**Syntax: ''''''Float'''''', degrees
*'''+Dinky:'''
**Whether to play if and only if the weapon is not armed. If false, the impact will not play if the weapon is not armed.
**Optional; defaults to false.
**Syntax: ''''''Boolean''''''
*'''+Effect Name:'''
**Name of [[Particle Effects|particle effect]] that will play when conditions are met.
**Syntax: ''''''String'''''', name of effect
}}

===$Inflight Effect:===
{{Table38|
*Sets the inflight [[Particle Effects|particle effect]] which is used when the laser is active. This is only used by laser weapons.
*Syntax: '''''String''''', the particle effect name
}}
===$Freeflight Effect:===
{{Table38|
*Sets the [[Particle Effects|particle effect]] which is used when the missile is in the free flight phase. See [[#$Free Flight Time:|$Free Flight Time]] for more information.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Ignition Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is transitioning from free flight to homed or unhomed flight.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Homed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in homed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Unhomed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in unhomed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$Muzzle Effect:===
*Defines the [[Particle Effects|particle effect]] used when the weapon fires. For muzzle effects, +Parent Velocity Factor uses the velocity of the firing ship, not the weapon.
*Syntax: '''''String''''', the particle effect name

===$EMP Intensity:===
*How deeply an EMP effect scrambles your electronics
**Needs the [[#EMP|EMP]] flag set to have any effect
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500.0
**Syntax: '''''Float''''' (defaults to 300.0)

===$EMP Time:===
*Duration of the EMP effect
**Needs the [[#EMP|EMP]] flag set to have any effect
**Syntax: '''''Float''''', seconds (defaults to 10.0)

===$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)

===$Vampiric Healing Factor:===
{{Table224|
*Multiplier for how much the shooter is healed after dealing hull damage (1.0 means healing done is equal to damage dealt)
**Needs the [[#Vampiric|Vampiric]] flag set to have any effect
*Must be a positive number higher than 0.0
**Syntax: '''''Float''''' (defaults to 1.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 missile's centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Like all spawn options, Spawn Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 180}}

===$Spawn Minimum Angle:===
{{Table202|
*Defines an inner angle for the cone within which the spawned weapons appear. ''Value'' gives the angle from the missile's centerline.
*Like all spawn options, Spawn Minimum Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 0}}

===$Spawn Interval:===
{{Table202|
*Causes the associated spawn event to happen continuously at this time interval. Enabling this will prevent the spawn event from triggering on detonation.
*NOTE: Having very large numbers of total children (low interval and/or high count) can cause issues for multiplayer, and you will be warned in multiplayer if the total count is greater then 300.
*Like all spawn options, Spawn Interval (and its associated Delay) should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', seconds, minimum is 0.1, '''You will not be warned for a negative spawn interval. ''' The value will be ignored and the spawn will be treated as a regular detonate spawn if negative. This is on purpose so that continuous/detonate spawns can be set regardless of the order in which they are defined in the flags.}}

====+Delay:====
{{Table202|
*Continuous spawn will not begin until this has elapsed.
*Syntax: '''''Float''''', seconds, default is 0}}

===$Spawn Effect:===
{{Table202|
*Specifies the [[Particle Effects|particle effect]] which will be used for continuous spawns of this weapon. Will not be used for detonation.
*Like all spawn options, Spawn Effect should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''String''', the particle effect name}}

===$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:===

*Defines the countermeasure effectiveness, radius, etc
{{note|
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:''').
*All countermeasures in the mission perform tests to spoof missiles for two frames after '''any countermeasure''' is created in the mission. No, this doesn't seem to make much sense.
{{Table382|The global frame counter can be bypassed by using '''[[#+Pulse Interval:|pulse interval]]'''.}}
*'''Provisional'''; Countermeasures are only given one chance to spoof any individual missile. This makes tuning seeker strength/effectiveness meaningful.
**Previously some record of which countermeasures had been seen by each missile was kept, but it broke when multiple countermeasures were involved. A good chance of breaking with two countermeasures, and a guaranteed chance of breaking with three or more. This reduced the impact of the seeker strength/effectiveness ratio, but was partly cancelled out by the 2 frames thing.
}}

{{Table3610|
===='''+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
}}

{{Table373|
====+Missile Detonation Radius:====
*Defines the radius within which a missile homing on this countermeasure will trigger a detonation (see '''+Single Missile Kill:''')
*Syntax: '''''Float''''', meters
**Default: 40.0
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}

====+Single Missile Kill:====
*Defines if countermeasures will detonate only the missile homing on this countermeasure, or every missile within '''+Missile Detonation Radius:'''
*Syntax: '''''Boolean'''''
**Default: false
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}
}}

{{Table382|
====+Pulse Interval:====
*Defines how much time passes between each pulse of this countermeasure.
*Syntax: '''''Float''''', milliseconds
**Default: 0
{{note| any value less than or equal to 0 means the countermeasure doesn't pulse, and uses the global 2-frame counter after any countermeasure is fired.}}
}}

{{Table212|
====+Use Fire Wait:====
*Makes the countermeasure fire wait use what is specified in the '''$Fire Wait:''' section of the weapon.
*Default countermeasure fire wait is 333 milliseconds, regardless of that value was set in '''$Fire Wait:'''.

====+Failure Launch Delay Multiplier for AI:====
*After a failed countermeasure launch the game waits a certain time interval before attempting another launch.
*Previously, the amount of time was calculated as ('fire wait' + 2000 * 'countermeasure firing chance').
*If set to a non negative number, this value will be multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: -1
{{note| any value less than 0 means the default formula will be used.}}

====+Successful Launch Delay Multiplier for AI:====
*After a successful countermeasure launch the game waits a certain time interval before attempting another launch.
*This value is multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: 2
{{note| any value less than 0 means the default value will be used.}}

}}

===$BeamInfo:===
*'''+Type:'''
*Defines the type of beam in question. This can be a number or, as of 21.4, a named type. Options are:
**''0'' or ''Direct fire'', a standard non-slashing type beam that fires directly at a random point on the target's hull
**''1'' or ''Slashing'', a slashing type beam, that slashes between opposing corners of the ship
**''2'' or ''Targeting'', a targeting beam that is used to trigger SSMs.
**''3'' or ''Antifighter'', a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles.
**''4'' or ''Normal Fire'', a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
{{Table214|
**''5'' or ''Omni'', a highly flexible kind of beam with many options for its exact behavior. See $Type 5 Beam Options below.}}
*'''+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
{{Table250|
*'''+Muzzle Particle Effect:
**Specifies the [[Particle Effects|particle effect]] which will be used for the muzzle warmup particles of this beam.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+PCount'', ''+PRadius'', ''+PAngle'' and ''+PAni'' are not valid options!
}}
*'''+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
{{Table372|
*'''+Directional Glow:'''
**Defines the length to stretch the muzzleglow along the beam.
**Syntax: '''''Float''''', length in meters, the muzzleglow is rendered along (in the same plane) as the beam instead of perpendicular to the camera.}}
{{Table240|
*'''+Opacity over Lifetime Curve:'''
**Specifies the curve to use for changing the beam's opacity over time.
**The life of the beam while firing (0-1) is X, the opacity is Y, where 0 is invisible and 1 is typical opacity.
**Syntax: ''String'', the name of the curve from [[Curves.tbl]]}}
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**ALSO AFFECTS FIGHTER BEAMS. If greater than 0, fires from up to that many fire points at a time before cycling. 1 mimics the behavior of weapons with the "cycle" flag, 0 fires from all available fire points like normal weapons.
**Syntax: '''''Integer''''', Default: 1
*'''+ShrinkFactor:'''
**How much of the beam's life is remaining before it starts to shrink in width. (0.1 means 10% life left)
**Syntax: '''''Float''''', value from 0 to 1
*'''+ShrinkPct:'''
**The beam's width factor is reduced by this amount every second. For example, a value of 0.25 means the beam is at 75% width after 1 second, 50% after 2, 25% after 3, and by 4 seconds it reaches the minimum size of 10%.
**Syntax: '''''Float''''', a positive value
{{Table202|
*'''+GrowFactor:'''
**How much of the beam's life is remaining before it starts to grow in width. (1.0 means as soon as the beam fires)
**Syntax: '''''Float''''', value from 0 to 1
*'''+GrowPct:'''
**The beam's width factor is increased by this amount every second. For example, a value of 0.25 means a beam starting at 0% is at 25% width after 1 second, 50% after 2, 75% after 3, and by 4 seconds it reaches the maximum size of 100%.
**Syntax: '''''Float''''', a positive value
*'''+Initial Width Factor:'''
**What factor of the beam's maximum width it starts with.
**Syntax: '''''Float''''', value from 0 to 1}}
{{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''''
{{Table222|
*'''+Beam Light Flickers:'''
*Controls if the dynamic flickering of the beam width is applied to the light cast by the beam as well
*Syntax: '''''boolean'''''
*Default value: True
*'''+Beam Width Multiplies Light Radius:'''
*Controls if the light radius of a beam is multiplied by the beam width.
*Syntax: '''''boolean'''''
*Default value: True}}
{{Table38|
*'''+Beam Flash Particle Effect:'''
**Specifies the beam flash [[Particle Effects|particle effect]].
**Syntax: '''''String''''', particle effect name
**If this is specified then '''+Beam Flash Effect''' and '''+Beam Flash Radius''' are not valid options!
}}
*'''+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'''''}}

{{Table214|
*'''$Type 5 Beam Options:'''
**Species the unique attributes for type 5 beams. '''None of these properties will be used if the weapon is not a type 5 beam.'''
**Fundamentally, type 5 beams are slashing type beams, where the start and end positions refer to physical positions in space (and not angles from the point of view of the shooter) and have many parameters for choosing their positions, including having them be on top of each other, and thus forgoing standard slashing behavior, and also for having rotations, both during the beam firing and in between firings.
*'''+Start Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
*'''+Start Position Offset:'''
**Displaces the chosen start position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+Start Position Randomness:'''
**Further displaces the chosen start position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"

*The following three fields can skipped, and the beam will not traditionally sweep like a slash beam (although it may still rotate).
*'''+End Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
***'''SAME RANDOM''', If the start position was randomly determined, this will cause the end position to inherit that position (it will not inherit offset or randomness, only the randomness from RANDOM ON/OFF SHIP).
*'''+End Position Offset:'''
**Displaces the chosen end position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+End Position Randomness:'''
**Further displaces the chosen end position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"
{{Table242|
*'''+Slash position over beam lifetime curve:'''
**Curve defining the beam's slash position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is slash position, with 0 being the start position and 1 the end position. Values outside of the 0-1 range will work.
***This is optional.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Orient Offsets to Target:'''
**This determines the orientation of the offsets and randomness.
**If this is set to ''TRUE'' then the x, y, and z, directions used refer to the target's x, y, and z coordinates. X being left/right, Y being up/down, Z being front/back. A start offset of 0, 0, 1, and an end offset of 0, 0, -1 would always cause the beam to fire at the target's bow and sweep to its aft, no matter which way the shooter is oriented.
**If this is set to ''FALSE'' then the x, y, and z, directions used refer to the shooter's x, y, and z coordinates. Using the z coordinate with this being false will have little effect. A start offset of 1, 0, 0, and an end offset of -1, 0, 0 would always cause the beam to fire towards the target, but to the shooter's right, and sweep in the direction of the shooter's left, regardless of how the target is oriented.
**Syntax: '''''Boolean''''', yes or no, Default: No
*'''+Scale Offsets to Target:'''
**This determines what a magnitude of 1 on the offsets and randomness mean.
**If this is set to ''TRUE'' then a value of 1 for a coordinate means a position in the chosen direction but at a distance equal to the target's radius. Values greater than 1, will drift further and further from the target entirely, while smaller than 1 will bring it closer to its originally chosen start position.
**If this is set to ''FALSE'' then it is as though it were firing at a target with a 300m radius at a 300m distance. A value of 1 corresponds to 45 degrees, which it will start at regardless of the distance of the target. Values greater than 1 will increase beyond 45 degrees but will never exceed 90 degrees
**Syntax: '''''Boolean''''', yes or no, Default: No

*'''+Continuous Rotation:'''
**This defines the degrees per second that the beam will rotate while it is firing.
**Syntax: '''''Float''''', degrees per second
*'''+Continuous Rotation Axis:'''
**This defines the axis about which the beam will continuously rotate. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will rotate about the start position before the offset or randomness were applied. A beam which does not slash (end position paramters omitted), but is offset and rotates about this axis will trace out circles, for instance.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will rotate about the final start position after offset and randomness have been applied. If this beam slashes (end position paramters specified) it will trace out a spiral.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will rotate about the center of the target.
{{Table242|
*'''+Rotation over beam lifetime curve:'''
**Curve defining the beam's rotational position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is rotational position, with 0 being no rotation and 1 being a full 360-degree turn. Values outside of the 0-1 range will work.
***This is optional.
***If a rotation curve is defined, "+Continuous Rotation" will do nothing.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Burst Rotation Pattern:'''
**Defines a list of rotations, for the final start and end positions to be performed right before firing for each specific shot in a burst (will not rotate the beam while firing). '''You will not be warned for failing to give this weapon burst capability''', because on spawned or subspace strike beams, providing a pattern has the additional effect of spawning multiple copies of this weapon all at once, each one corresponding to another entry in the pattern.
**For instance, a standard slash with a rotation pattern of (0, 180) will cause the beam weapon to slash back and forth, or in a scissor pattern if the burst is very short and the beams fire at similar times.
**(0,120,240) will have 3 slashes in a triangular pattern.
**If a RANDOM ON/OFF SHIP option has been chosen for the start or end positions, the "burst shares random target" flag may be used so all shots in the burst share the same random position.
**If any values are '''''negative''''' they will instead use a random amount of rotation for that entry.
**Syntax: '''''List of Floats''''', degrees. Example: (0, 90, 180, 270)
*'''+Burst Rotation Axis:'''
**The axis about which to rotate for the burst rotation pattern. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
*'''Per Burst Rotation:'''
**Will rotate the final start and end positions, possibly in addition to the burst rotation pattern, for each burst of the beam, or every shot if not a burst weapon.
**If this value is '''''negative''''' this will instead be treated as a random amount of rotation.
**Syntax: '''''Float''''', degrees.
*'''+Per Burst Rotation Axis:'''
**The axis about which to rotate for the per burst rotation. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
}}
{{Table232|
*'''+Firing Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the entire active length of the beam while it is firing and active.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table232|
*'''+Paused Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the length of the beam while it is firing, but in between bursts of a type 4 anti-fighter beam.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table212|
*'''+Beam Flags:'''
*Extra flags specific to beams
**'''burst shares random target''', all shots from this beam weapon in the same burst will target the same random point (or slash direction)
**'''track own texture tiling''', the 'U' position of the beam texture, whose speed is set by '''+Translation:''' below, is tracked independently, rather than being shared among all beams like normal.
}}

*'''$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 valid when editing beam sections that already exist in other tables. Attempting to index new sections will generate warnings, adding new sections is the default behavior for un-indexed sections.
:**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. (Zadd can be safely ignored; it actually does nothing.)
:**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.
{{Table250|
**May be any positive number.
}}
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
{{Table250|
*'''+Effect:'''
**Specifies the [[Particle Effects|particle effect]] which will be used for this Pspew.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+Type'', ''+Count'', ''+Time'', ''+Vel'', ''+Radius'', ''+Life'', ''+Scale'', ''+Z Scale'', ''+Rotation Rate'', ''+Offset'', ''+Initial Velocity'' and ''+Bitmap'' are not valid options!
}}
*'''+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 illuminates 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
*'''Note''': TAG will not trigger unless the weapon in question has a non-zero damage value.

===$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}}

====+FOF Spread Rate:====
{{Table37|
*Defines the spread rate of the field of fire. This is a percentage of the +Max FOF: defined below, and is applied each time the weapon is fired. For exaple, a value of 0.1 causes the field of fire to increase by 10% of the +Max FOF: per trigger pull. This is unaffected by the number of fire points.
*Syntax: ''''''Float'''''', rate}}

====+FOF Reset Rate:====
{{Table37|
*Rate at which the spread decreases if the weapon isn't firing. This is a percentage of the +Max FOF: defined below, and is applied once per second. For example, a value of 0.1 causes the field of fire to decrease by 10% of the +Max FOF: per second.
*(If you want to get technical, this is applied every frame, but scaled by the percentage of a second that frame represents. For almost all practical purposes, saying it's applied once per second is equivalent, and makes the calculation easier to think about.)
*Syntax: ''''''Float'''''', rate
*This is required if '''+FOF Spread Rate:''' is present}}

====+Max FOF:====
{{Table37|
*The maximum FOF. After the FOF reaches this value it will not increase any further.
*Syntax: ''''''Float'''''', degrees. Must be greater than or equal to zero.
*This is required if '''+FOF Spread Rate:''' is present}}
{{Table242|
As of 24.2, this can be specified without also specifying <tt>+FOF Spread Rate:</tt>.}}

===$Firing Pattern:===
{{Table250|
*Determines the order in which the weapon is fired from a bank's gunpoints. Does nothing for secondary weapons.
*This is optional. If a firing pattern is not set, the weapon will fire from all gunpoints simultaneously, as is standard retail behavior.
*If a firing pattern is set, the weapon's '''$Fire Wait''' will be divided by the number of gunpoints in the bank, so as to keep shots-per-second constant.
*Has five options:
**'''CYCLE FORWARD''': Fires '''$Shots''' shots from the first '''$Shots''' gunpoints (starting at gunpoint 0), then from the next '''$Shots''' gunpoints, and so on.
**'''CYCLE REVERSE''': Same behavior as CYCLE FORWARD, but begins at the highest-numbered gunpoint and works downward.
**'''RANDOM EXHAUSTIVE''': Fires '''$Shots''' shots at a time from randomly-selected gunpoints until each gunpoint has been fired once, and then starts over.
**'''RANDOM NONREPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time, but never fires the same gunpoint twice in a row (unless forced to because $Shots is equal to more than half the number of gunpoints).
**'''RANDOM REPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time. No restrictions.
*Syntax: ''''''String''''''}}

===$Shots:===
{{Table3610|
*Defines the number of shots created at each firepoint each time the weapon is fired. Produces shotgun-like behavior if used with '''$FOF'''.
*If the weapon has a non-standard firing pattern, instead determines the number of firepoints fired at a time.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$Cycle Multishot:===
{{Table250|
*If the weapon has a non-standard firing pattern, defines the number of shots created at each firepoint. Otherwise, does nothing.
*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}}

===$Impact decal:===
{{Table190|
*Defines an impact decal (think bullet impact/scorch mark) using the new system introduced in FSO 19.0.0.
**Syntax: '''''String''''', this must match to one of the entries in a [[Decals|decal tbm]].
*'''+Radius:'''
**Syntax: '''''[[Parsed random range]]''''', Radius of the impact decal; default is 1.0
*'''+Lifetime:'''
**Syntax: Either '''''Eternal''''' or '''''[[Parsed random range]]''''', lifetime in seconds
}}
{{Table224|
*'''+Use Random Rotation:'''
**Syntax: '''''Boolean''''', Whether or not a random rotation is added to the decal; default is NO
}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strength 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
*If this weapon is cycling each individual firing event counts as one burst shot, so bursts end sooner in time for large banks than small.
**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).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}
{{Table220|'''"num firepoints for burst shots"''', for turrets, makes the burst length equal to the number of firepoints on the turret.}}
{{Table240|'''"burst only loop sounds"''', StartFiringSnd, LoopFiringSnd, and EndFiringSnd, if used, additionally also trigger off of when bursts begin and end.}}

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

===$Failure Rate:===
{{Table38|
*Defines the random chance that the weapon will fail to fire, or spawn the substitute below if specified.
**Syntax: '''''Float''''', 0 - 1

====+Failure Substitute:====
*Defines the weapon to substitute when the weapon 'fails'.
**Syntax: '''''String''''', Weapon
}}

===$On Create:===
{{Table212|
*Defines an [[Action System|action system]] program set to be executed when a weapon of this type is created. Only applicable to laser and missile style weapons.
}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations for weapons. Weapon needs to be a modelled weapon for animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Animations:===
{{Table242|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven animations '''are not''' compatible with $Animations! If you need animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

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

*'''Indexes start at 0 for the first weapon'''

*'''If the first index you specify is higher than 0, it will also be used for the indexes before it.'''

}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this weapon class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Weapon Class to find the CustomData Lua Table.
====+Val:====
Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.

====$end_custom_data====
Mandatory entry to indicate that the Custom Data list has ended. }}

==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.
*The flag will parse without a value, using a default of 10.
{{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, but only if the weapon is in a turret or is a secondary. If the weapon is a primary in a fighter then there are no targeting restrictions. See [[Weapons.tbl#.22capital.2B.22|capital+]] instead.

==="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 target-able with the B key and interceptable by AIs
** Has been long thought to make the AI prefer this weapon against large ships, but in fact has no effect on AI weapon selection.

==="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]]

==="Vampiric"===
{{Table224|
*Heals shooter upon dealing hull damage to target
*Can be defined with [[Weapons.tbl#$Vampiric Healing Factor:|Vampiric Healing Factor]]}}

==="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.) Only applies to the target selection of turrets, has no effect on the behavior of fighters picking primary and secondary bank weapons.}}

==="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}}

==="hide from radar"===
{{Table3614|
*Prevents weapon from being visible on the radar}}

==="capital+"===
{{Table3613|
*Tells AI fighters/bombers to use this weapon only on capital ships. Has no effect on turret AI.}}

==="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).'''}}

==="aoe electronics"===
{{Table372|
*Apply electronics effect across the weapon's entire area of effect instead of just on the impacted ship}}

==="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.}}

==="don't spawn if shot"===
{{Table373|
*Prevents parent weapons from spawning children in the even of the parent weapon being shot down.}}

==="die on lost lock"===
{{Table373|
*Aspect seeking missiles (only, not heat seekers) will detonate upon losing their lock. Currently they only lose lock if decoyed by a countermeasure, AND "pulls aspect seekers" or similar is not set. The detonation will use their "dinky" explosion (i.e. same as if ran out of lifetime).}}

==="no doublefire"===
{{Table202|
*Prevents dual-firing of secondary weapons. If the ship tries to dual-fire a weapon with this flag they are set back to single fire.}}

==="no impact spew"===
{{Table202|
*Turns off the usual spew effects that occur on the impacted ship when a weapon hits it.}}

==="require exact los"===
{{Table202|
*Prevent AI form firing this weapon from a turret or as a secondary weapon if there is no clear line of sight from the weapons firing point to its targeted ship (center). Note that this may keep the weapon trained on a target out of sight while another target may be available to shoot.}}

==="can damage shooter"===
{{Table212|
*This weapon can collide with and directly damage the original shooter of this weapon (even if it was spawned), which is not normally possible.}}

==="heals"===
{{Table214|
*This weapon uses its $Damage value to heal its target(s) instead of damaging them.
*This works very similarly to damage, the armor/shield/subsystem factors apply to healing as well as do armor classes. However, there are some caveats. 
*Healing will ''always'' carry. Unlike damage, which first has to go through the shield, has damage subtracted, then damages subsystems, has damage subtracted, then finally damages the hull if any damage remains, healing will apply in full to hull, shield, and subsystems (factors or armor classes notwithstanding). A weapon with 100 'healing' will attempt to apply that healing to the hull, shield and nearby subsystems to the impact. Even if the weapon only heals hull, it will still do so even if it strikes the shield.
*This flag has '''''no effect''''' on AI. Fighters armed with a healing weapon will happily heal hostile targets they were ordered to attack.}}

==="secondary no ammo"===
{{Table220|
*If this is a secondary weapon, it does not need to consume any ammo, and will not display ammo in the weapon HUD gauge, etc.}}

==="no collide"===
{{Table220|
*This weapon will not collide with any other object.}}

==="multilock target dead subsys"===
{{Table220|
*If this is a multilock weapon, dead subsystems will be treated as just as valid targets as alive ones.}}

==="no evasion"===
{{Table220|
*AI will not attempt to evade this weapon when fired at them}}

==="no_fred"===
{{Table224|
*Weapon will not appear in any of the FRED dropdown lists for weapon classes.}}

==="detonate on expiration"===
{{Table232|
*Primary weapon will detonate as if hitting a target when it reaches the end of its lifetime - just like a secondary weapon does by default.}}

==="freespace 1 missile behavior"===
{{Table250|
*Enables a set of behaviors observed from missiles in the Freespace 1 release.
**Detonate when within 50 meters and not pointing at their target.
**Move slower than normal when not pointing at their target.
**Aspect seekers follow a -1x lag pursuit scalar for the last second before hitting their target.
*Note that the last point will make aspect seekers much less likely to hit moving targets.
*[[Ai_profiles.tbl#.24enable_freespace_1_style_missile_behavior:|Can be applied globally using an AI profile]]
*Syntax: '''''Boolean'''''}}

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

2025-07-09T08:48:37Z

Lafiel: new particle options

{{TableVersionGit|2024-12-10|228fd17}}
{{Tables}}
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

==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 primary weapons''', as well '''flak weapons'''. Traditionally, '''beam weapons''' are also defined in this section.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***Defines '''beam weapons'''. Traditionally they appear in the primary weapon section, but this is technically their proper place.
**<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).

NOTE: Beam weapons defined in the primary section will receive the WP_LASER subtype, and beam weapons defined in the beam section will receive the WP_BEAM subtype. They will behave identically in most respects, with the only in-game difference being a somewhat larger and asymmetrical impact explosion effect for WP_BEAM. In scripts, beams will return true for '''isLaser()''' if they have the WP_LASER subtype, and false if they have the WP_BEAM subtype. (They will always return true for '''isBeam()'''.)

==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]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in weapons.tbl or in earlier parsed *-wep.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

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

===$Turret Name:===
{{Table222|
*Renames a turret to this if this is the first weapon on a turret.
*Syntax: XSTR('''''"String"''''', -1)}}

===$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. Only valid if a tech model is defined
*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.
}}
{{Table38|
*Note: It's no longer required that the ship actually have external models enabled (whether or not this weapon has one defined) for the spin up delay to occur.
}}

===$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 Head-on Bitmap:====
{{Table220|
Defines another laser graphic file to be used and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@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 Glow Head-on Bitmap:====
{{Table220|
Defines another graphic file to be used for the laser glow and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Head-on Transition Angle:====
{{Table220|
Overrides the angle in degrees from the front (or back) that the head-on transition crossfade is at exactly a 50/50 blend.

Syntax: '''''Float''''', degrees
Default: Calculated from the ratio of the laser's length to its average radius}}

====@Laser Head-on Transition Rate:====
{{Table220|
Defines how quickly the head-on transition fades from one bitmap to the other. Greater than 20 is an instant switch with no blending.

Syntax: '''''Float'''''
Default: 2}}

====@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
{{Table240|
===@Laser Length Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's length over time.
*The life of the weapon (0-1) is X, the length multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Head Radius:====
Defines the radius 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.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser head's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters

====@Laser Tail Radius:====
Defines the radius 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.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser tail's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters
{{Table240|
===@Laser Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's radius values (both head and tail) over time.
*The life of the weapon (0-1) is X, the radius multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Glow Length Scale:====
Scaling factor for glow bitmap along the length axis, relative to the length of the main laser bitmap. Default is 2.0.

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

====@Laser Glow Head Scale:====
Scaling factor for the radius of the glow bitmap at its head, relative to the radius of the main laser bitmap's head. Default is 2.3.
*Note that laser length is calculated in an odd way: the head and tail are treated as ''spheres'', with the length being the distance between the centers of those spheres, so the actual length of a laser (or laser glow) is length + head radius + tail radius.
*This can result in unintuitive behavior if glow length scaling is set differently from head or tail scaling.
*However, as long as length, head, and tail glow scale are all set to the same value, the glow bitmap will be scaled up while maintaining the same aspect ratio as the laser.
Syntax: '''''Float'''''

====@Laser Glow Tail Scale:====
Scaling factor for the radius of the glow bitmap at its tail, relative to the radius of the main laser bitmap's tail. Default is 2.3.
*See note in head scale entry regarding unintuitive behavior.
Syntax: '''''Float'''''

====@Laser Position Offset:====
Moves the laser relative to its collision point by multiples of the laser length, along any of the three axes. For example, a value of -1.0 along the Z axis will move the laser backward so that the visible laser no longer extends forward from the collision point, but backward, with the collision point at the head rather than the tail. A value of 1.0 along the X axis will move the laser one laser-length to the right.
*Important note: the X and Y axes are relative to the orientation of the weapon, which normally seems to match the orientation of the firing ship, but which is not guaranteed to remain stable. If the weapon rotates, the orientation of the offset will rotate with it.
Syntax: '''''Vector'''''

====@Laser Min Pixel Size:====
If this is set to a non-zero value, the laser will always be at least the specified number of pixels wide, no matter how far away it is. Defaults to the $Minimum Pixel Size Lasers: value in Game settings.tbl, or to 0 if that is not set.

Syntax: '''''Integer'''''

{{Table240|
===@Laser Opacity Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's opacity over time.
*The life of the weapon (0-1) is X, the opacity is Y, with 0 being invisible and 1 being typical opacity.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Light color:===
{{Table222|
*Sets the color of light cast by the weapon.
*Syntax: '''''Color''''', red, green, blue respectively, from 0 to 255
*Default value: If not set, the color is white for weapons with models, or based on the laser colors otherwise }}

===$Light radius:===
{{Table222|
*Sets the maximum distance light cast by the weapon will reach. Increasing this will tend to make it appear brighter near it's center
*Syntax: '''''float''''', any positive value
*Default value: The defaults for different weapon types are set in [[Lighting_Profiles.tbl]]}}

===$Light intensity:===
{{Table222|
*Acts as a multiplier to the brightness of the light cast by the weapon. This changes the brightness without affecting the radius.
*Syntax: '''''float''''', any positive value
*Default value: 1}}

===$Collision Radius Override:===
{{Table202|
*Weapon - weapon collisions are treated as two spheres, where a laser's sphere's radius is equal to its Head Radius, and a missile's is the radius of its associated model (possibly doubled). Using this will override either of those values.
*If used on a beam it will override its collision radius as well, instead of using the widest section.
*NOTE: If the weapon is interceptable, such as a bomb or has been given hitpoints, this value will ''still'' be doubled, unless the "no radius doubling" flag is used.
*Syntax: '''''Float''''', meters}}

===$Mass:===
*Scales the kinetic effect this weapon has on its target. With higher mass imparting a stronger effect.
*The eventual kinetic effect is also multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. This is also true for the intesnity of the "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

====+Max Delay:====
{{Table373|
*Defines the maximum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Min Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

====+Min Delay:====
{{Table373|
*Defines the minimum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Max Delay: to have any effect.
*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 approximately 5.88 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*The exact factor to multiply by is 100/17, or one 'pulse' of damage every 170 seconds. The generally used wisdom of 5.5 times may have been generally accurate before beam damage was made continuous and frame-rate independent, but is now out of date information.
*Syntax: '''''Float''''', damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)

===$Damage Time:===
{{Table373|
*This sets a time from the end of the weapons lifetime that damage will start to attenuate at. '''''Example: Weapon lifetime is 2.0 seconds and the desired effect is to attenuate after 0.5 seconds have passed, set this to 1.5 seconds.'''''
*Syntax: '''''Float''''', seconds. Defaults to 0.0.
**Note: If neither +Min Damage: nor +Max Damage: is set, the damage will always attenuate to zero at max range.
***If both +Min Damage: and +Max Damage: are set, both are defaulted to 0.0 and damage will be attenuated to zero.}}

====+Attenuation Damage:====
{{Table373|
*This sets the damage a weapon will attenuate to after reaching $Damage Time:.
*Syntax: '''''Float''''', damage.}}

====+Min Damage:====
{{Table373|
*This sets the lowest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

====+Max Damage:====
{{Table373|
*This sets the highest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

===$Angle of Incidence Damage Multiplier:===
{{Table212|
*Causes the weapon's damage to be multiplied by these factors depending on the angle of incidence.
*It is ''not'' linear, it is based on the sine of the angle to the surface. If the factors are 1x for minimum, and 2x for maximum, at an angle of 45° the multiplier is 1.707x, for instance.
====+Min:====
*The damage multiplier at a perfectly glancing hit, parallel to the surface (although not technically possible).
*Syntax: '''''Float'''''
====+Max:====
*The damage multiplier when hit straight on, perpendicular to the surface.
*Syntax: '''''Float'''''}}
{{Table240|
===$Damage Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's damage over time.
*The life of the weapon (0-1) is X, the damage multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$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}}

===$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 traveling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in 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]]}}

===$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
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*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)
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters
{{Table240|
===$Shockwave Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the shockwave's radius over time. This will ''ignore'' $Shockwave Speed for the purposes of determining the size of the shockwave over time, however $Outer radius / $Shockwave Speed will still be the total time that the shockwave lasts. Even if the multiplier goes beyond 1, the shockwave still cannot hit or damage targets beyond its $Outer radius.
*The life of the shockwave (0-1) is X, the outer radius multiplier is Y. This will entirely determine how the shockwave grows and shrinks over time.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that any area-effect damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated. Random, if left undefined.
*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}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$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:'''''}}
{{Table202|
*'''''+Shockwave sound:'''''}}

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

{{Table250|
===$Launch Curve:===
*A set of [[modular curve]]s that controls the firing behavior of the weapon. These curves will have no effect on beams.
*Available inputs:
**'''Num Firepoints''': the number of barrels in the bank firing the weapon
**'''Distance to Target'''
**'''Target Radius'''
*Available outputs:
**'''Fire Wait Mult'''
**'''Shots Mult'''
**'''Burst Shots Mult'''
**'''Burst Delay Mult'''
**'''Velocity Mult'''
**'''Life Mult'''
**'''Failure Rate Mult'''
**'''FoF Mult'''

===$Lifetime Curve:===
*A set of [[modular curve]]s, dealing with changes to the weapon during its existence. These curves will have no effect on beams.
*Available inputs:
**'''Lifetime''': starts at 0.0 when the weapon is created, ends at 1.0 when it runs out of life
**'''Age''': how long the weapon has existed, in seconds
**'''Base Velocity''': the weapon's velocity. This accounts for launch curves, but does NOT account for other lifetime curves, so as to avoid a feedback loop.
**'''Base Damage''': the weapon's damage. This accounts for launch curves, but does NOT account for hit curves, so as to avoid a feedback loop.
**'''Max Hitpoints'''
**'''Current Hitpoints'''
**'''Hitpoints Fraction''': the weapon's current hitpoints divided by its maximum hitpoints
**'''Parent Radius''': radius of the ship ultimately responsible for firing the weapon
**'''Viewing Angle''': direction from which the player is looking at the weapon. -1.0 means directly head-on, 0.0 means directly from the side, and 1.0 means directly from the rear.
**'''Apparent Size''': the weapon's radius as a fraction of the screen height
*Available outputs:
**'''Laser Length Mult'''
**'''Laser Radius Mult'''
**'''Laser Head Radius Mult'''
**'''Laser Tail Radius Mult'''
**'''Laser Offset X Mult'''
**'''Laser Offset Y Mult'''
**'''Laser Offset Z Mult'''
**'''Laser Headon Transition Angle Mult'''
**'''Laser Headon Transition Rate Mult'''
**'''Laser Animation State''': sets the animation state of the laser, with 0.0 being the first frame of the animation, and 1.0 being the last. If this is used, all typical animation behavior (i.e. playing at a certain framerate over time) will be ignored.
**'''Laser Animation State Add''': adds a certain number of frames to the laser's animation state. Does not disable typical animation behavior on its own.
**'''Laser Alpha Mult'''
**'''Laser Bitmap R Mult'''
**'''Laser Bitmap G Mult'''
**'''Laser Bitmap B Mult'''
**'''Laser Glow R Mult'''
**'''Laser Glow G Mult'''
**'''Laser Glow B Mult'''
**'''Light Intensity Mult'''
**'''Light Radius Mult'''
**'''Light R Mult'''
**'''Light G Mult'''
**'''Light B Mult'''
**'''Detonation Radius Mult'''
**'''Turn Rate Mult'''
**'''Child Spawn Rate Mult'''
**'''Child Spawn Count Mult'''

===$Hit Curve:===
*A set of [[modular curve]]s, controlling how the weapon affects things it hits. These curves will have no effect on beams.
*Available inputs:
**'''All of the Lifetime Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
**'''Dot''': the angle at which the weapon has struck the target surface. 1.0 means a direct hit, perpendicular to the target surface. 0.0 would mean a hit exactly parallel to the surface.
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''

===$Beam Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''Beam Lifetime''': the beam's lifetime, from 0.0 to 1.0, not including the warmup or warmdown phases
**'''Beam Age''': in seconds
**'''Beam Total Life''': how long the beam is capable of lasting, not including warmup or warmdown
**'''Warmup Lifetime''': lifetime of the warmup phase, starting at 0.0 and ending at 1.0 when the beam fires
**'''Warmdown Lifetime'''
**'''Warmdown Age''': time elapsed since warmdown started, in seconds
**'''Parent Radius'''
*Available outputs:
**'''Beam Width Mult''': does NOT disable tabled flickering or shrinking if set
**'''Beam Alpha Mult'''
**'''Beam Anim State''': behaves like laser anim state
**'''Muzzle Glow Radius Mult''': if this is set, the typical hardcoded muzzle glow size behaviors are disabled
**'''Muzzle Glow Alpha Mult''': if this is set, the typical hardcoded muzzle glow fading behaviors are disabled
**'''Muzzle Glow Anim State''': behaves like laser anim state
**'''Move End Position by Target Velocity''': if the beam is slashing at a target, the beam's end position will be offset by the target's velocity (at time of beam creation) times this output value

===$Beam Hit Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''All of the Beam Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''
}}

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turreted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Autoaim FOV:===
{{Table224|
'''This option is exclusive to primaries.'''
*Defines if the weapon will have auto-aim and what the FOV of the auto-aim is.
*Syntax: '''''Float'''''}}

===$Homing:===
'''This option is exclusive to secondaries.'''
{{Table212|'''This option may now be applied to primaries'''. They may only use heat seeking. For optimal results the "no homing speed ramp" flag may be used.}}

Defines if the bolts/missiles in question is homing

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 quickly the missile can turn. Ostensibly the number of seconds it takes the missile to do a 360 degree circle at full turn speed, but for complicated reasons this is only true if [[Game_settings.tbl#.2BAI_respect_tabled_turn_time_and_rotdamp|AI respect tabled turn time and rotdamp]] is enabled.
**Syntax: '''''Float''''', seconds

===='''+Turning Acceleration Time:'''====
{{Table202|
Determines how quickly the missile reaches its maximum turn speed.
*Note: Requires [[Game_settings.tbl#.24AI_use_framerate_independent_turning:|$AI use framerate independent turning]] in game_settings.tbl
**Syntax: '''''Float''''', seconds}}
{{Table240|
===+Turn Rate Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's turn rate over time.
*The life of the weapon (0-1) is X, the turn rate multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===='''+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. They will continue to home on targets outside their view cone, but will take a continuous lifetime penalty every second their target is outside this cone.}}

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

===='''+Lock FOV:'''====
{{Table234|
Defines the width of the cone within which the missile is capable of achieving a lock, in degrees. Only applies to aspect seekers.
*Syntax: '''''Float''''', default (approximately): 63.57666}}

===='''+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.}}

===='''+Target Lock Restriction:'''====
{{Table202|
Defines if the missile can lock onto ships besides the current target
*Syntax: '''''String''''', name of the behavior, default is ''current target only'';.
*''Current target only'' As normal, can only acquire locks on the targeted ship
*''Any target'' Missile will lock on any valid target. Missile locking is still disabled in certain cases, such as when a friendly is the player's target
*''Current target, any subsystem'' Targeting is restricted to the current ship, but will pick turrets and subsystems on that ship. }}

===='''+Independent Seekers:'''====
{{Table202|
Defines the ability for a missile to target multiple objects at once.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Target Lock Objecttypes:'''====
{{Table220|
Defines what type of object can be locked on with this weapon
*Syntax: '''''String''''', name of the object type, default is ''ships''
*''ships'' Will target only ships
*''bombs'' Will target bombs and targetable missiles }}

===='''+Trigger Hold:'''====
{{Table202|
Defines the ability to hold the trigger to lock and release to fire.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Reset On Launch:'''====
{{Table202|
Defines the ability for locks to reset upon missiles being fired.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Max Seekers Per Target:'''====
{{Table202|
Defines the maximum number of seekers that can target a single object.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Max Active Seekers:'''====
{{Table202|
Defines the maximum number of total seekers for the weapon to have.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Ship Types:'''====
{{Table202|
Defines the ship types that this missile can target. In order for a ship to be targetable it must be able to match one of the listed types, if some of the below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship types.}}

===='''+Ship Classes:'''====
{{Table202|
Defines the ship classes that this missile can target. In order for a ship to be targetable it must be able to match one of the listed classes, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship classes.}}

===='''+Species:'''====
{{Table202|
Defines the species whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed Species, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', species.}}

===='''+IFFs:'''====
{{Table202|
Defines the IFF's whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed IFFs, if some of the above lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', IFFs.}}

===$Homing Auto-Target Method:===
{{Table214|
*If this weapon needs to acquire a target on its own, such as a heatseeker losing its target or having the "untargeted heatseeker" flag, this determines how it should do so. Options are:
*'''CLOSEST''', the weapon will acquire the nearest target that it is able.
*'''RANDOM''', the weapon will acquire a random target from those available.
}}

===$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.
*Swarm will negatively affect the missile's ability to hit its target and will not lead its target even with [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] defined unless [[Game_settings.tbl#.24Swarmers_Lead_Targets:|$Swarmers Lead Targets]] is enabled.
*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)}}

===$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 traveling 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 parses but doesn't use the value, and prints a warning in the log. This feature has subsequently been reimplemented, see $Free Flight Speed Factor: below}}
}}

===$Free Flight Speed Factor:===
{{Table202|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
}}

===$Gravity Const:===
{{Table224|
*If the mission has gravity, this is the multiplier applied to acceleration from gravity on the weapon.
*AI will lead for ballistic trajectories, and this may affect their range as they will not fire unless they can successfully make a ballistic path to their target.
*'''Homing weapons are unaffected by gravity no matter what'''.
*Syntax: '''''Float'''''
**Default: 0}}

===$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]]

===$CockpitLaunchSnd:===
{{Table232|
*Corresponding sound effect when the weapon is launched from the player's ship, allowing use of 2d stereo sounds.
*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

{{Table214|
===$AmbientSnd:===
*The sound this weapon passively emits in 3d space. The weapon version of [[Ships.tbl#.24EngineSnd:|EngineSnd]] for ships.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$StartFiringSnd:===
*The sound that plays when the user presses the trigger down while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$LoopFiringSnd:===
*The sound that plays while the user is firing the weapon and is holding the trigger down.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$EndFiringSnd:===
*The sound that plays when the user releases the trigger while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$TrackingSnd===
{{Table3615|
*The looping sound played when the player is tracking a target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when the player has locked onto their target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played while the player has this weapon 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 frequency that weapons are loaded to the ship
*Syntax: '''''Float''''', How many times per second the weapons are loaded.
**Example: 2.0 will reload every half second. 0.1 will load every ten seconds.

===$Rearm Ammo Increment:===
{{Table38|
*Defines how many missiles or how much ballistic ammo is loaded per load sound.
*Syntax: '''''Integer''''', how many bullets or missiles are loaded. Default 4 for missiles, 100 for ballistic primaries.}}

===+Weapon Range:===
*If set, the AI will use this value or the result of weapon lifetime * velocity as the weapon's effective range, whichever is lower. This also affects the [[Hud_gauges.tbl#Lead_Indicator|Lead Indicator]]
*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}}

===+Weapon Optimum Range:===
{{Table214|
*AI fightercraft will attempt to close the distance to their target while they are outside of this range and using this weapon as their currently equipped primary.
*Syntax: '''''Float''''', meters}}

===$Pierce Objects:===
{{Table212|
*Causes the weapon to penetrate the objects impacted and not be destroyed.
*Syntax: '''''Boolean'''''
====+Spawn Children On Pierce:====
*Will spawn the weapons children on each hit, not just when it eventually gets destroyed through lifetime
*Syntax: '''''Boolean'''''}}

===$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
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
**Larger numbers above 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Smaller numbers below 1 cause it to fade away quickly at first, and then slow down for most of its life.
**Syntax: '''''Float''''', positive}}
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
{{Table202|
*'''+Spread:'''
**Causes the trail points to diffuse and drift apart at this speed over time.
**Syntax: '''''Float''''', meters per second}}
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table212|
*'''+Bitmap Stretch:'''
**Multiplies how far the bitmap is stretched over each trail segment.
**Syntax: '''''Float'''''}}
{{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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for impacts of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!
}}

===$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 impact explosion if it hits the shield, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Shield Impact Effect Radius:===
{{Table250|
*Radius of the visual effect displayed on the shield mesh when this weapon hits the shield, see also [[Ships.tbl#.2BMax Shield Impact Effect Radius:]].
*Syntax: '''''Float''''', meters}}

===$Dinky Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for Dinky (not armed) explosions of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Dinky Impact Explosion'' and ''$Dinky Impact Explosion Radius'' are not valid options!
}}

===$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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for piercing impacts.
*Syntax: '''String''', the particle effect name
*If this option is specified then piercing impact options below are not valid!
}}

===$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.

===$Conditional Impact:===
{{Table242|
*Defines an impact effect that will play for this weapon only under certain conditions.
*May be defined any number of times.
*Currently only works for targets that are ships or weapons. Impacts against weapons are not considered to have a hit angle.
*All conditional impacts whose requirements are met will play.
*Non-conditional impact effects, the ones defined above, will only play if no conditional impacts' requirements are met.
*'''+Armor Type:'''
**Name of armor type the target must have in order for this impact to play. Shields can have their own armor types. (Subsystems can as well, but at present this system will not detect that.)
**Syntax: ''''''String'''''', name of armor type in [[armor.tbl]]
*'''+Min Health Threshold:'''
**Fraction of target health below which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Max Health Threshold:'''
**Fraction of target health above which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 1.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Min Angle Threshold:'''
**Hit angle -- that is, the angle measuring how 'straight on' you're hitting the target surface -- below which impact will not play.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', degrees
*'''+Max Angle Threshold:'''
**Hit angle above which impact will not play.
**Optional; defaults to 180.0.
**Syntax: ''''''Float'''''', degrees
*'''+Dinky:'''
**Whether to play if and only if the weapon is not armed. If false, the impact will not play if the weapon is not armed.
**Optional; defaults to false.
**Syntax: ''''''Boolean''''''
*'''+Effect Name:'''
**Name of [[Particle Effects|particle effect]] that will play when conditions are met.
**Syntax: ''''''String'''''', name of effect
}}

===$Inflight Effect:===
{{Table38|
*Sets the inflight [[Particle Effects|particle effect]] which is used when the laser is active. This is only used by laser weapons.
*Syntax: '''''String''''', the particle effect name
}}
===$Freeflight Effect:===
{{Table38|
*Sets the [[Particle Effects|particle effect]] which is used when the missile is in the free flight phase. See [[#$Free Flight Time:|$Free Flight Time]] for more information.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Ignition Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is transitioning from free flight to homed or unhomed flight.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Homed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in homed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Unhomed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in unhomed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$Muzzle Effect:===
*Defines the [[Particle Effects|particle effect]] used when the weapon fires. For muzzle effects, +Parent Velocity Factor uses the velocity of the firing ship, not the weapon.
*Syntax: '''''String''''', the particle effect name

===$EMP Intensity:===
*How deeply an EMP effect scrambles your electronics
**Needs the [[#EMP|EMP]] flag set to have any effect
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500.0
**Syntax: '''''Float''''' (defaults to 300.0)

===$EMP Time:===
*Duration of the EMP effect
**Needs the [[#EMP|EMP]] flag set to have any effect
**Syntax: '''''Float''''', seconds (defaults to 10.0)

===$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)

===$Vampiric Healing Factor:===
{{Table224|
*Multiplier for how much the shooter is healed after dealing hull damage (1.0 means healing done is equal to damage dealt)
**Needs the [[#Vampiric|Vampiric]] flag set to have any effect
*Must be a positive number higher than 0.0
**Syntax: '''''Float''''' (defaults to 1.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 missile's centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Like all spawn options, Spawn Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 180}}

===$Spawn Minimum Angle:===
{{Table202|
*Defines an inner angle for the cone within which the spawned weapons appear. ''Value'' gives the angle from the missile's centerline.
*Like all spawn options, Spawn Minimum Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 0}}

===$Spawn Interval:===
{{Table202|
*Causes the associated spawn event to happen continuously at this time interval. Enabling this will prevent the spawn event from triggering on detonation.
*NOTE: Having very large numbers of total children (low interval and/or high count) can cause issues for multiplayer, and you will be warned in multiplayer if the total count is greater then 300.
*Like all spawn options, Spawn Interval (and its associated Delay) should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', seconds, minimum is 0.1, '''You will not be warned for a negative spawn interval. ''' The value will be ignored and the spawn will be treated as a regular detonate spawn if negative. This is on purpose so that continuous/detonate spawns can be set regardless of the order in which they are defined in the flags.}}

====+Delay:====
{{Table202|
*Continuous spawn will not begin until this has elapsed.
*Syntax: '''''Float''''', seconds, default is 0}}

===$Spawn Effect:===
{{Table202|
*Specifies the [[Particle Effects|particle effect]] which will be used for continuous spawns of this weapon. Will not be used for detonation.
*Like all spawn options, Spawn Effect should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''String''', the particle effect name}}

===$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:===

*Defines the countermeasure effectiveness, radius, etc
{{note|
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:''').
*All countermeasures in the mission perform tests to spoof missiles for two frames after '''any countermeasure''' is created in the mission. No, this doesn't seem to make much sense.
{{Table382|The global frame counter can be bypassed by using '''[[#+Pulse Interval:|pulse interval]]'''.}}
*'''Provisional'''; Countermeasures are only given one chance to spoof any individual missile. This makes tuning seeker strength/effectiveness meaningful.
**Previously some record of which countermeasures had been seen by each missile was kept, but it broke when multiple countermeasures were involved. A good chance of breaking with two countermeasures, and a guaranteed chance of breaking with three or more. This reduced the impact of the seeker strength/effectiveness ratio, but was partly cancelled out by the 2 frames thing.
}}

{{Table3610|
===='''+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
}}

{{Table373|
====+Missile Detonation Radius:====
*Defines the radius within which a missile homing on this countermeasure will trigger a detonation (see '''+Single Missile Kill:''')
*Syntax: '''''Float''''', meters
**Default: 40.0
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}

====+Single Missile Kill:====
*Defines if countermeasures will detonate only the missile homing on this countermeasure, or every missile within '''+Missile Detonation Radius:'''
*Syntax: '''''Boolean'''''
**Default: false
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}
}}

{{Table382|
====+Pulse Interval:====
*Defines how much time passes between each pulse of this countermeasure.
*Syntax: '''''Float''''', milliseconds
**Default: 0
{{note| any value less than or equal to 0 means the countermeasure doesn't pulse, and uses the global 2-frame counter after any countermeasure is fired.}}
}}

{{Table212|
====+Use Fire Wait:====
*Makes the countermeasure fire wait use what is specified in the '''$Fire Wait:''' section of the weapon.
*Default countermeasure fire wait is 333 milliseconds, regardless of that value was set in '''$Fire Wait:'''.

====+Failure Launch Delay Multiplier for AI:====
*After a failed countermeasure launch the game waits a certain time interval before attempting another launch.
*Previously, the amount of time was calculated as ('fire wait' + 2000 * 'countermeasure firing chance').
*If set to a non negative number, this value will be multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: -1
{{note| any value less than 0 means the default formula will be used.}}

====+Successful Launch Delay Multiplier for AI:====
*After a successful countermeasure launch the game waits a certain time interval before attempting another launch.
*This value is multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: 2
{{note| any value less than 0 means the default value will be used.}}

}}

===$BeamInfo:===
*'''+Type:'''
*Defines the type of beam in question. This can be a number or, as of 21.4, a named type. Options are:
**''0'' or ''Direct fire'', a standard non-slashing type beam that fires directly at a random point on the target's hull
**''1'' or ''Slashing'', a slashing type beam, that slashes between opposing corners of the ship
**''2'' or ''Targeting'', a targeting beam that is used to trigger SSMs.
**''3'' or ''Antifighter'', a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles.
**''4'' or ''Normal Fire'', a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
{{Table214|
**''5'' or ''Omni'', a highly flexible kind of beam with many options for its exact behavior. See $Type 5 Beam Options below.}}
*'''+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
{{Table250|
*'''+Muzzle Particle Effect:
**Specifies the [[Particle Effects|particle effect]] which will be used for the muzzle warmup particles of this beam.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+PCount'', ''+PRadius'', ''+PAngle'' and ''+PAni'' are not valid options!
}}
*'''+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
{{Table372|
*'''+Directional Glow:'''
**Defines the length to stretch the muzzleglow along the beam.
**Syntax: '''''Float''''', length in meters, the muzzleglow is rendered along (in the same plane) as the beam instead of perpendicular to the camera.}}
{{Table240|
*'''+Opacity over Lifetime Curve:'''
**Specifies the curve to use for changing the beam's opacity over time.
**The life of the beam while firing (0-1) is X, the opacity is Y, where 0 is invisible and 1 is typical opacity.
**Syntax: ''String'', the name of the curve from [[Curves.tbl]]}}
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**ALSO AFFECTS FIGHTER BEAMS. If greater than 0, fires from up to that many fire points at a time before cycling. 1 mimics the behavior of weapons with the "cycle" flag, 0 fires from all available fire points like normal weapons.
**Syntax: '''''Integer''''', Default: 1
*'''+ShrinkFactor:'''
**How much of the beam's life is remaining before it starts to shrink in width. (0.1 means 10% life left)
**Syntax: '''''Float''''', value from 0 to 1
*'''+ShrinkPct:'''
**The beam's width factor is reduced by this amount every second. For example, a value of 0.25 means the beam is at 75% width after 1 second, 50% after 2, 25% after 3, and by 4 seconds it reaches the minimum size of 10%.
**Syntax: '''''Float''''', a positive value
{{Table202|
*'''+GrowFactor:'''
**How much of the beam's life is remaining before it starts to grow in width. (1.0 means as soon as the beam fires)
**Syntax: '''''Float''''', value from 0 to 1
*'''+GrowPct:'''
**The beam's width factor is increased by this amount every second. For example, a value of 0.25 means a beam starting at 0% is at 25% width after 1 second, 50% after 2, 75% after 3, and by 4 seconds it reaches the maximum size of 100%.
**Syntax: '''''Float''''', a positive value
*'''+Initial Width Factor:'''
**What factor of the beam's maximum width it starts with.
**Syntax: '''''Float''''', value from 0 to 1}}
{{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''''
{{Table222|
*'''+Beam Light Flickers:'''
*Controls if the dynamic flickering of the beam width is applied to the light cast by the beam as well
*Syntax: '''''boolean'''''
*Default value: True
*'''+Beam Width Multiplies Light Radius:'''
*Controls if the light radius of a beam is multiplied by the beam width.
*Syntax: '''''boolean'''''
*Default value: True}}
{{Table38|
*'''+Beam Flash Particle Effect:'''
**Specifies the beam flash [[Particle Effects|particle effect]].
**Syntax: '''''String''''', particle effect name
**If this is specified then '''+Beam Flash Effect''' and '''+Beam Flash Radius''' are not valid options!
}}
*'''+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'''''}}

{{Table214|
*'''$Type 5 Beam Options:'''
**Species the unique attributes for type 5 beams. '''None of these properties will be used if the weapon is not a type 5 beam.'''
**Fundamentally, type 5 beams are slashing type beams, where the start and end positions refer to physical positions in space (and not angles from the point of view of the shooter) and have many parameters for choosing their positions, including having them be on top of each other, and thus forgoing standard slashing behavior, and also for having rotations, both during the beam firing and in between firings.
*'''+Start Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
*'''+Start Position Offset:'''
**Displaces the chosen start position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+Start Position Randomness:'''
**Further displaces the chosen start position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"

*The following three fields can skipped, and the beam will not traditionally sweep like a slash beam (although it may still rotate).
*'''+End Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
***'''SAME RANDOM''', If the start position was randomly determined, this will cause the end position to inherit that position (it will not inherit offset or randomness, only the randomness from RANDOM ON/OFF SHIP).
*'''+End Position Offset:'''
**Displaces the chosen end position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+End Position Randomness:'''
**Further displaces the chosen end position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"
{{Table242|
*'''+Slash position over beam lifetime curve:'''
**Curve defining the beam's slash position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is slash position, with 0 being the start position and 1 the end position. Values outside of the 0-1 range will work.
***This is optional.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Orient Offsets to Target:'''
**This determines the orientation of the offsets and randomness.
**If this is set to ''TRUE'' then the x, y, and z, directions used refer to the target's x, y, and z coordinates. X being left/right, Y being up/down, Z being front/back. A start offset of 0, 0, 1, and an end offset of 0, 0, -1 would always cause the beam to fire at the target's bow and sweep to its aft, no matter which way the shooter is oriented.
**If this is set to ''FALSE'' then the x, y, and z, directions used refer to the shooter's x, y, and z coordinates. Using the z coordinate with this being false will have little effect. A start offset of 1, 0, 0, and an end offset of -1, 0, 0 would always cause the beam to fire towards the target, but to the shooter's right, and sweep in the direction of the shooter's left, regardless of how the target is oriented.
**Syntax: '''''Boolean''''', yes or no, Default: No
*'''+Scale Offsets to Target:'''
**This determines what a magnitude of 1 on the offsets and randomness mean.
**If this is set to ''TRUE'' then a value of 1 for a coordinate means a position in the chosen direction but at a distance equal to the target's radius. Values greater than 1, will drift further and further from the target entirely, while smaller than 1 will bring it closer to its originally chosen start position.
**If this is set to ''FALSE'' then it is as though it were firing at a target with a 300m radius at a 300m distance. A value of 1 corresponds to 45 degrees, which it will start at regardless of the distance of the target. Values greater than 1 will increase beyond 45 degrees but will never exceed 90 degrees
**Syntax: '''''Boolean''''', yes or no, Default: No

*'''+Continuous Rotation:'''
**This defines the degrees per second that the beam will rotate while it is firing.
**Syntax: '''''Float''''', degrees per second
*'''+Continuous Rotation Axis:'''
**This defines the axis about which the beam will continuously rotate. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will rotate about the start position before the offset or randomness were applied. A beam which does not slash (end position paramters omitted), but is offset and rotates about this axis will trace out circles, for instance.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will rotate about the final start position after offset and randomness have been applied. If this beam slashes (end position paramters specified) it will trace out a spiral.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will rotate about the center of the target.
{{Table242|
*'''+Rotation over beam lifetime curve:'''
**Curve defining the beam's rotational position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is rotational position, with 0 being no rotation and 1 being a full 360-degree turn. Values outside of the 0-1 range will work.
***This is optional.
***If a rotation curve is defined, "+Continuous Rotation" will do nothing.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Burst Rotation Pattern:'''
**Defines a list of rotations, for the final start and end positions to be performed right before firing for each specific shot in a burst (will not rotate the beam while firing). '''You will not be warned for failing to give this weapon burst capability''', because on spawned or subspace strike beams, providing a pattern has the additional effect of spawning multiple copies of this weapon all at once, each one corresponding to another entry in the pattern.
**For instance, a standard slash with a rotation pattern of (0, 180) will cause the beam weapon to slash back and forth, or in a scissor pattern if the burst is very short and the beams fire at similar times.
**(0,120,240) will have 3 slashes in a triangular pattern.
**If a RANDOM ON/OFF SHIP option has been chosen for the start or end positions, the "burst shares random target" flag may be used so all shots in the burst share the same random position.
**If any values are '''''negative''''' they will instead use a random amount of rotation for that entry.
**Syntax: '''''List of Floats''''', degrees. Example: (0, 90, 180, 270)
*'''+Burst Rotation Axis:'''
**The axis about which to rotate for the burst rotation pattern. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
*'''Per Burst Rotation:'''
**Will rotate the final start and end positions, possibly in addition to the burst rotation pattern, for each burst of the beam, or every shot if not a burst weapon.
**If this value is '''''negative''''' this will instead be treated as a random amount of rotation.
**Syntax: '''''Float''''', degrees.
*'''+Per Burst Rotation Axis:'''
**The axis about which to rotate for the per burst rotation. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
}}
{{Table232|
*'''+Firing Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the entire active length of the beam while it is firing and active.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table232|
*'''+Paused Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the length of the beam while it is firing, but in between bursts of a type 4 anti-fighter beam.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table212|
*'''+Beam Flags:'''
*Extra flags specific to beams
**'''burst shares random target''', all shots from this beam weapon in the same burst will target the same random point (or slash direction)
**'''track own texture tiling''', the 'U' position of the beam texture, whose speed is set by '''+Translation:''' below, is tracked independently, rather than being shared among all beams like normal.
}}

*'''$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 valid when editing beam sections that already exist in other tables. Attempting to index new sections will generate warnings, adding new sections is the default behavior for un-indexed sections.
:**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. (Zadd can be safely ignored; it actually does nothing.)
:**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.
{{Table250|
**May be any positive number.
}}
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
{{Table250|
*'''+Effect:'''
**Specifies the [[Particle Effects|particle effect]] which will be used for this Pspew.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+Type'', ''+Count'', ''+Time'', ''+Vel'', ''+Radius'', ''+Life'', ''+Scale'', ''+Z Scale'', ''+Rotation Rate'', ''+Offset'', ''+Initial Velocity'' and ''+Bitmap'' are not valid options!
}}
*'''+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 illuminates 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
*'''Note''': TAG will not trigger unless the weapon in question has a non-zero damage value.

===$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}}

====+FOF Spread Rate:====
{{Table37|
*Defines the spread rate of the field of fire. This is a percentage of the +Max FOF: defined below, and is applied each time the weapon is fired. For exaple, a value of 0.1 causes the field of fire to increase by 10% of the +Max FOF: per trigger pull. This is unaffected by the number of fire points.
*Syntax: ''''''Float'''''', rate}}

====+FOF Reset Rate:====
{{Table37|
*Rate at which the spread decreases if the weapon isn't firing. This is a percentage of the +Max FOF: defined below, and is applied once per second. For example, a value of 0.1 causes the field of fire to decrease by 10% of the +Max FOF: per second.
*(If you want to get technical, this is applied every frame, but scaled by the percentage of a second that frame represents. For almost all practical purposes, saying it's applied once per second is equivalent, and makes the calculation easier to think about.)
*Syntax: ''''''Float'''''', rate
*This is required if '''+FOF Spread Rate:''' is present}}

====+Max FOF:====
{{Table37|
*The maximum FOF. After the FOF reaches this value it will not increase any further.
*Syntax: ''''''Float'''''', degrees. Must be greater than or equal to zero.
*This is required if '''+FOF Spread Rate:''' is present}}
{{Table242|
As of 24.2, this can be specified without also specifying <tt>+FOF Spread Rate:</tt>.}}

===$Firing Pattern:===
{{Table250|
*Determines the order in which the weapon is fired from a bank's gunpoints. Does nothing for secondary weapons.
*This is optional. If a firing pattern is not set, the weapon will fire from all gunpoints simultaneously, as is standard retail behavior.
*If a firing pattern is set, the weapon's '''$Fire Wait''' will be divided by the number of gunpoints in the bank, so as to keep shots-per-second constant.
*Has five options:
**'''CYCLE FORWARD''': Fires '''$Shots''' shots from the first '''$Shots''' gunpoints (starting at gunpoint 0), then from the next '''$Shots''' gunpoints, and so on.
**'''CYCLE REVERSE''': Same behavior as CYCLE FORWARD, but begins at the highest-numbered gunpoint and works downward.
**'''RANDOM EXHAUSTIVE''': Fires '''$Shots''' shots at a time from randomly-selected gunpoints until each gunpoint has been fired once, and then starts over.
**'''RANDOM NONREPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time, but never fires the same gunpoint twice in a row (unless forced to because $Shots is equal to more than half the number of gunpoints).
**'''RANDOM REPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time. No restrictions.
*Syntax: ''''''String''''''}}

===$Shots:===
{{Table3610|
*Defines the number of shots created at each firepoint each time the weapon is fired. Produces shotgun-like behavior if used with '''$FOF'''.
*If the weapon has a non-standard firing pattern, instead determines the number of firepoints fired at a time.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$Cycle Multishot:===
{{Table250|
*If the weapon has a non-standard firing pattern, defines the number of shots created at each firepoint. Otherwise, does nothing.
*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}}

===$Impact decal:===
{{Table190|
*Defines an impact decal (think bullet impact/scorch mark) using the new system introduced in FSO 19.0.0.
**Syntax: '''''String''''', this must match to one of the entries in a [[Decals|decal tbm]].
*'''+Radius:'''
**Syntax: '''''[[Parsed random range]]''''', Radius of the impact decal; default is 1.0
*'''+Lifetime:'''
**Syntax: Either '''''Eternal''''' or '''''[[Parsed random range]]''''', lifetime in seconds
}}
{{Table224|
*'''+Use Random Rotation:'''
**Syntax: '''''Boolean''''', Whether or not a random rotation is added to the decal; default is NO
}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strength 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
*If this weapon is cycling each individual firing event counts as one burst shot, so bursts end sooner in time for large banks than small.
**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).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}
{{Table220|'''"num firepoints for burst shots"''', for turrets, makes the burst length equal to the number of firepoints on the turret.}}
{{Table240|'''"burst only loop sounds"''', StartFiringSnd, LoopFiringSnd, and EndFiringSnd, if used, additionally also trigger off of when bursts begin and end.}}

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

===$Failure Rate:===
{{Table38|
*Defines the random chance that the weapon will fail to fire, or spawn the substitute below if specified.
**Syntax: '''''Float''''', 0 - 1

====+Failure Substitute:====
*Defines the weapon to substitute when the weapon 'fails'.
**Syntax: '''''String''''', Weapon
}}

===$On Create:===
{{Table212|
*Defines an [[Action System|action system]] program set to be executed when a weapon of this type is created. Only applicable to laser and missile style weapons.
}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations for weapons. Weapon needs to be a modelled weapon for animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Animations:===
{{Table242|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven animations '''are not''' compatible with $Animations! If you need animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

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

*'''Indexes start at 0 for the first weapon'''

*'''If the first index you specify is higher than 0, it will also be used for the indexes before it.'''

}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this weapon class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Weapon Class to find the CustomData Lua Table.
====+Val:====
Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.

====$end_custom_data====
Mandatory entry to indicate that the Custom Data list has ended. }}

==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.
*The flag will parse without a value, using a default of 10.
{{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, but only if the weapon is in a turret or is a secondary. If the weapon is a primary in a fighter then there are no targeting restrictions. See [[Weapons.tbl#.22capital.2B.22|capital+]] instead.

==="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 target-able with the B key and interceptable by AIs
** Has been long thought to make the AI prefer this weapon against large ships, but in fact has no effect on AI weapon selection.

==="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]]

==="Vampiric"===
{{Table224|
*Heals shooter upon dealing hull damage to target
*Can be defined with [[Weapons.tbl#$Vampiric Healing Factor:|Vampiric Healing Factor]]}}

==="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.) Only applies to the target selection of turrets, has no effect on the behavior of fighters picking primary and secondary bank weapons.}}

==="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}}

==="hide from radar"===
{{Table3614|
*Prevents weapon from being visible on the radar}}

==="capital+"===
{{Table3613|
*Tells AI fighters/bombers to use this weapon only on capital ships. Has no effect on turret AI.}}

==="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).'''}}

==="aoe electronics"===
{{Table372|
*Apply electronics effect across the weapon's entire area of effect instead of just on the impacted ship}}

==="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.}}

==="don't spawn if shot"===
{{Table373|
*Prevents parent weapons from spawning children in the even of the parent weapon being shot down.}}

==="die on lost lock"===
{{Table373|
*Aspect seeking missiles (only, not heat seekers) will detonate upon losing their lock. Currently they only lose lock if decoyed by a countermeasure, AND "pulls aspect seekers" or similar is not set. The detonation will use their "dinky" explosion (i.e. same as if ran out of lifetime).}}

==="no doublefire"===
{{Table202|
*Prevents dual-firing of secondary weapons. If the ship tries to dual-fire a weapon with this flag they are set back to single fire.}}

==="no impact spew"===
{{Table202|
*Turns off the usual spew effects that occur on the impacted ship when a weapon hits it.}}

==="require exact los"===
{{Table202|
*Prevent AI form firing this weapon from a turret or as a secondary weapon if there is no clear line of sight from the weapons firing point to its targeted ship (center). Note that this may keep the weapon trained on a target out of sight while another target may be available to shoot.}}

==="can damage shooter"===
{{Table212|
*This weapon can collide with and directly damage the original shooter of this weapon (even if it was spawned), which is not normally possible.}}

==="heals"===
{{Table214|
*This weapon uses its $Damage value to heal its target(s) instead of damaging them.
*This works very similarly to damage, the armor/shield/subsystem factors apply to healing as well as do armor classes. However, there are some caveats. 
*Healing will ''always'' carry. Unlike damage, which first has to go through the shield, has damage subtracted, then damages subsystems, has damage subtracted, then finally damages the hull if any damage remains, healing will apply in full to hull, shield, and subsystems (factors or armor classes notwithstanding). A weapon with 100 'healing' will attempt to apply that healing to the hull, shield and nearby subsystems to the impact. Even if the weapon only heals hull, it will still do so even if it strikes the shield.
*This flag has '''''no effect''''' on AI. Fighters armed with a healing weapon will happily heal hostile targets they were ordered to attack.}}

==="secondary no ammo"===
{{Table220|
*If this is a secondary weapon, it does not need to consume any ammo, and will not display ammo in the weapon HUD gauge, etc.}}

==="no collide"===
{{Table220|
*This weapon will not collide with any other object.}}

==="multilock target dead subsys"===
{{Table220|
*If this is a multilock weapon, dead subsystems will be treated as just as valid targets as alive ones.}}

==="no evasion"===
{{Table220|
*AI will not attempt to evade this weapon when fired at them}}

==="no_fred"===
{{Table224|
*Weapon will not appear in any of the FRED dropdown lists for weapon classes.}}

==="detonate on expiration"===
{{Table232|
*Primary weapon will detonate as if hitting a target when it reaches the end of its lifetime - just like a secondary weapon does by default.}}

==="freespace 1 missile behavior"===
{{Table250|
*Enables a set of behaviors observed from missiles in the Freespace 1 release.
**Detonate when within 50 meters and not pointing at their target.
**Move slower than normal when not pointing at their target.
**Aspect seekers follow a -1x lag pursuit scalar for the last second before hitting their target.
*Note that the last point will make aspect seekers much less likely to hit moving targets.
*[[Ai_profiles.tbl#.24enable_freespace_1_style_missile_behavior:|Can be applied globally using an AI profile]]
*Syntax: '''''Boolean'''''}}

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

2025-07-09T08:39:48Z

Lafiel: /* Ships Table Options */

{{TableVersionGit|2024-11-13|d6b444c}}
{{Tables}}
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

See the article [[Subsystem]] for ship table information that is specific to subsystems.

==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.
{{Table202|
:*<nowiki>#</nowiki>'''Wing Formations'''
:**Includes the list of custom wingmate formations}}
:*'''$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]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in ships.tbl or in earlier parsed *-shp.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

===$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
*This setting does nothing
*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, when originally introduced, caused crashes and memory issues. Between 2014/07/24 and 2015/8/20, it was removed from the codebase. In short: do not use in versions prior to 3.7.4.}}
{{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}}

===+Use Ship as Template:===
{{Table232|
*Creates a copy of the specified ship to use as a base for this ship.
*'''''Caution!''''' This is highly dependent on the order the tables are loaded. If the ship used as a template is modified using <tt>+nocreate</tt>, the tabled changes will only be applied to the newly created ship if they are loaded ''before'' <tt>+Use Ship as Template</tt>. Any <tt>+nocreate</tt> changes ''after'' <tt>+Use Ship as Template</tt> will not have any effect on the newly created ship class. Thus, proper templates should be preferred if possible.
*Cannot be used in conjunction with <tt>+Use Template</tt>.
*Syntax: '''''String''''', name of the ship class to use as a template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship. Used to rename ships without breaking missions.
*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 -ship_choice_3d commandline flag is enabled or no ani can be found for the selected ship.
*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 Animations:===
{{Table230|
*Allows specifying animations that only run on the cockpit model of a ship
*See [[#$Animations:|$Animations]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Cockpit Animations:===
{{Table242|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven cockpit animations '''are not''' compatible with $Cockpit Animations! If you need cockpit animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

===$Cockpit Moveables:===
{{Table230|
*Allows specifying moveables that only run on the cockpit model of a ship
*See [[#$Moveables:|$Moveables]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

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

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*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:===
NOTE: this option has done nothing since before 2008

*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 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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used on weapon impact,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Spew'' is not a valid option!
}}

===$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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used for the smoke of a weapon impact,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Damage Spew'' is not a valid option!
*Note that the scaling applied by ''$Damage Spew'' '''is not''' applied to''$Damage Spew Effect:'' automatically. If desired, it has to be manually added using ''$Particle Source Curve:'' within the particle definition
}}

===$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).
}}
{{Table202|
====+Collision Sound Light:====
Sound when this ship collides normally.
====+Collision Sound Heavy:====
Sound when this ship collides at high speed.
====+Collision Sound Shielded:====
Sound when this ship collides with shields active.
}}

===$Gravity Const:===
{{Table224|
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship.
**Note that due to the exponential damping from $Damp, the acceleration from gravity will eventually even out with $Damp and result in a constant velocity in the direction of gravity.
**Syntax: '''''Float'''''}}

===$Dying Gravity Const:===
{{Table224|
**Same as above, but while ths ship is dying/in death roll.
**The aforementioned exponential damp is still in effect during this time, but it is weaker.
**Syntax: '''''Float'''''
**Default: The same as $Gravity Const:}}

===$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'''''}}
{{Table250|
*'''+Hitpoints Radius Multiplier:'''
**Defines the hitpoints multiplier. By default this is -1 and thus disabled, but if set to a value greater than or equal 0, the debris hitpoints will be multiplied by this value and the radius of the debris submodel. Useful for making debris have hitpoints that vary based on size of the debris piece.
**Syntax: '''''Float'''''
}}
{{Table3611|
*'''+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}}
{{Table224|
*'''+Debris Gravity Const:'''
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship's debris.
**Syntax: '''''Float'''''
**Default: The same as $Dying Gravity Const}}
{{Table232|
*'''+Debris Density:'''
**Same as [[Ship.tbl#$Density:|Density]] but only applied to the ship's debris.
**Syntax: '''''Float'''''
**Default: 1.0}}
{{Table202|
*'''+Ambient Sound:'''
**The sound played in the vicinity of debris.}}
{{Table212|
*'''+Generic Debris POF file:'''
**The filename of the ship's generic debris, by default debris01.pof.
**Big or huge ships do not normally have generic debris, but if this is specified for them, they will generate generic debris on explosion.
**Syntax: '''''String'''
*'''+Generic Debris Spew Num:'''
**How many generic debris fragments to generate when the ship explodes.
**If this is a big or huge ship, this is the number of generic debris fragments to generate for every individual propagating explosion.
**Syntax: '''''Integer'''
**Default: ''20''}}

===$Density:===
*Multiplies the mass and moment of inertia of the relevant ship.
*Ships with a high mass and moment of inertia will be moved/rotated by collisions and impacts less strongly.
*Syntax: '''''Float''''', usually 1. Must not be 0.

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

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.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), but only for the player, the AI will act as though it is still 0.
*Syntax: '''''Float'''''
*Defaults to 0.}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode.
**If > 0, sets a fixed acceleration rate in glide mode: ships will accelerate at their tabled maximum velocity along the given axis, interpreted in m/s^2, multiplied by ''+Glide Accel Mult:''.
**If set to 0, impossible to accelerate while in glide mode.
**If negative, enables glide speed ramping: acceleration in glide mode ramps using the same constants as in normal flight. Note, however, that glide acceleration ignores the ship's ''$Damp:'' value, so glide acceleration will always be faster than in normal flight; and if the damping constant is significantly larger than the acceleration constant along a given axis, this difference will become very pronounced.
*Syntax: '''''Float'''''
*Default: ''0''}}
{{Table3610|
*Entry exists as a dummy entry which doesn't 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}}

===+Primary Bank Autoaim FOV:===
{{Table232|
*Defines the autoaim for the primary bank.
*Can be listed once for each existing bank on the ship.
*Syntax: '''''Float'''''}}

===$Aims at Flight Cursor:===
{{Table242|
*Enables flight cursor-style flying for the ship, and causes the ship to fire in the direction of the cursor.
*'''Note:''' Only works for players! AI may need a system like autoaim to mimic it.
*Syntax: '''''Boolean'''''}}

===+Extent:===
{{Table242|
*Required if the above is true.
*How many degrees away from the center the player is allowed to shoot, using the flight cursor.
*Syntax: '''''Float''''', degrees}}

===$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|
:*''[Fireball Unique ID]'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*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}}

===$Supercap warpin physics:===
{{Table234|
*Specifies whether this ship should use supercap deceleration when arriving, similar to the Colossus. Can also disable supercap deceleration on a ship that normally has it.
*Syntax: '''''Boolean'''''}}

===$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|
:*''[Fireball Unique ID]'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*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, [[Game_settings.tbl#.24Minimum player warpout time:|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}}

===$Supercap warpout physics:===
{{Table234|
*Specifies whether this ship should use special physics when departing, as a complement to $Supercap warpin physics. Currently has no effect.
*Syntax: '''''Boolean'''''}}

===$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 has many smaller explosions while in its death-roll. Also determines whether the ship splits in two or not unless explicitly set below.
*Syntax: '''''Boolean''''', yes or no

===$Expl Splits Ship:===
{{Table202|
*Whether the ship splits in two and slowly explodes outward towards its front and back, or just immediately explodes into debris.
*Syntax: '''''Boolean''''', yes or no, defaults to the value of '$Expl Propagates:' above}}

===$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}}

===$Death Roll Rotation Multiplier:===
{{Table202|
*Multiplies the strength of the rotation imparted by death-rolling.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used when a ship is splitting apart,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Splitting Particles'' is not a valid option!
}}

===$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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used when a knossos type object is dying.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Alternate Death Particles'' is not a valid option!
}}

===$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}}

===$Debris Flame Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be added to debris spawned from this ship.
*Syntax: '''String''', the particle effect name
}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]]. Note that this option is misleadingly named; "vaporization" usually refers to a ship exploding into tiny debris shards rather than hull chunks.
*Syntax: '''''Float''''', percent chance of instant explosion, 0 to 100}}
{{Table240|In version 24.0 and later, '''$Skip Death Roll Percent Chance:''' can be used as a more accurate alternative.}}

===$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}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the ship explosion shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$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 its 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 its 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 its 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)''
*Note: This requires the [[Weapons.tbl#.24External_Model_File:|$External_Model_File entry to be defined in weapons.tbl]]. Weapons without external models will revert to the standard behaviour.
*Behavior is as follows:
**If your bank carries fewer or as many missiles as the number of gunpoints on your bank, you will have exactly as many external model shown as you have missiles left in your bank (going in the order of gunpoints defined in the POF). External models will disappear when missiles are fired.
**If your bank carries more missiles than you have gunpoints in your bank, then external models will "recoil" (to simulate a reloading animation) every time you fire, and will disappear based on the % of missile left in the bank. Example: you have 2 gunpoints and 4 missiles, the first external model will disappear after you fire the second missile.
**If your weapon uses the [[Weapons.tbl#.22external_model_launcher.22|"external_model_launcher" flag]], then the model will be displayed on all gunpoints and will not recoil nor disappear when fired.}}

===$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.}}
}}

===$Allowed Firing Patterns for Dynamic Primary Linking:===
{{Table250|
*If the ship has dynamic primary linking enabled, defines the list of firing patterns which the player may cycle through using the appropriate control.
*This is optional. If not set, the only firing pattern available will be CYCLE FORWARD.
*Takes a list of patterns. The options are:
**'''CYCLE FORWARD''': Fires '''$Shots''' shots from the first '''$Shots''' gunpoints (starting at gunpoint 0), then from the next '''$Shots''' gunpoints, and so on.
**'''CYCLE REVERSE''': Same behavior as CYCLE FORWARD, but begins at the highest-numbered gunpoint and works downward.
**'''RANDOM EXHAUSTIVE''': Fires '''$Shots''' shots at a time from randomly-selected gunpoints until each gunpoint has been fired once, and then starts over.
**'''RANDOM NONREPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time, but never fires the same gunpoint twice in a row (unless forced to because $Shots is equal to more than half the number of gunpoints).
**'''RANDOM REPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time. No restrictions.
*Syntax: '''String list''', for example, ("CYCLE FORWARD", "CYCLE REVERSE")}}

===$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}}

====+Max Shield Impact Effect Radius:====
{{Table250|
*Caps the size of the visual effect displayed on the shield mesh from impacts.
*Syntax: '''''Float''''', meters}}

===$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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be triggered when this ship's shields are hit.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Shield Impact Explosion'' is not a valid option!
}}

===$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/afterburner energy regeneration is disabled. Checked via code inspection 2014-12-29
{{Table250|
If the current AI profile has the '''$ETS uses ship class power output:''' flag enabled, this will act as a multiplier for ETS energy. For example, a ship with a power output of 2 will recharge its afterburner twice as fast as a ship with the same stats but a power output of 1.
}}
*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''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===+Shield Regen Hit Delay:===
{{Table214|
*Specifies a time delay after being hit by a weapon before the shield may begin regenerating again.
*Syntax: '''''Float''''', seconds}}

===$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''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Shield to Weapon Transfer Quantity:===
{{Table202|
*The fraction of ''maximum'' shield capacity to use when making direct shield -> weapon energy transfers.
*Syntax: '''''Float'''''
**Default: ''0.2''
*'''Note:''' default direct transfers have a large and poorly-appreciated impact on ETS balancing. If you care about balancing your ship's weapon and shield recharge rates you are advised to set this to 0.}}

===$Shield to Weapon Transfer Efficiency:===
{{Table202|*The fraction of the transferred shield energy that will actually end up in the weapon capacitor.
*Syntax: '''''Float'''''
**Default: ''1.0''
*Note that the amount deposited will be absolute, not relative. For instance, for a ship with 100 weapon energy and 200 shields and default quantity and efficiency, a shield->weapon transfer will deduct 40 shield energy and add 40 weapon energy. It is entirely possible for efficiency to be more than 1.0.
*Unless transfer efficiency is tuned to account for the different charge rates for weapons and shields, direct transfers will tend to make the ETS unbalanced in the hands of an experienced player, as in retail.}}

===$Shield to Weapon Transfer Speed:===
{{Table202|*The rate at which transferred energy will move into the weapon capacitor,
*Syntax: '''''Float'''''
**Default:''0.04''
*When energy is transferred it is instantly deducted from shields, but it must 'trickle' into the weapon capacitor at a fixed fraction per second. This acts as a second bonus recharge on top of whatever the ETS produces.}}

===$Weapon to Shield Transfer Quantity:===

===$Weapon to Shield Transfer Efficiency:===

===$Weapon to Shield Transfer Speed:===

{{Table202|As above, but with the transfer direction reversed.}}

===$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''''', percentage of hitpoints repaired per second}}

===$Hull Self Repair Maximum:===
{{Table220|
*Maximum percentage of total hull strength that the hull will self-repair to.
*Syntax: '''''Float''''', percentage of hull hitpoints}}

===$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'', percentage of total subsystem hitpoints repaired per second}}

===$Subsystem Self Repair Maximum:===
{{Table220|
*Maximum percentage of total subsystem strength that subsystems will self-repair to.
*Syntax: '''''Float''''', percentage of subsystems hitpoints}}

===$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.
*Exact fuel recharged per second is given by the ETS value (as a percentage of total power output) multiplied by twice the tabled recharge rate, and then multiplied by the difficulty setting.
*Syntax: '''''Float''''', fuel units per second
====+Aburn Minimum Start Fuel:====
{{Table202|
*Minimum afterburner fuel the ship must have before allowed to afterburn.
*Syntax: '''''Float''''', fuel}}
====+Aburn Minimum Fuel to Burn:====
{{Table202|
*Forces the ship to afterburn until at least this much fuel is used, or it runs out of fuel.
*Syntax: '''''Float''''', fuel}}
====+Aburn Cooldown Time:====
{{Table202|
*How much time must have elapsed since the last afterburn finished to allow afterburning again.
*Syntax: '''''Float''''', seconds}}
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
{{Table212|
=====+Bitmap Stretch:=====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
=====+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'''''
{{Table212|
=====+Alpha Decay Exponent:=====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
{{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

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Scanning time multiplier:===
{{Table220|
*A factor to apply to scan time when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Scanning range multiplier:===
{{Table220|
*A factor to apply to scan distance when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$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]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by 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]]
}}

===$DeathRollSnd===
{{Table202|
*Optional sound to be used for the sound heard when the ship enters its death roll
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

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

===$SubsysExplosionSnd===
{{Table202|
*Optional sound to be used for the sound heard when a subsystem on this ship explodes
*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 and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

{{Table381|
===$Closeup_pos_targetbox:===
*Optional value to set for the position of the camera relative to the model in the HUD target box view. If not set then the value for $Closeup_pos: will be used.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom_targetbox:===
*Optional value to set how the model will show in the HUD target box view. How far the camera's zoomed in, defines camera's FOV. If not set then the value for $Closeup_zoom: will be used.
*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}}

===$Chase View Offset:===
{{Table214|
*Specifies a custom camera position when the ship is being viewed in the chase camera.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively in meters}}

===$Chase View Rigidity:===
{{Table214|
*Specifies how 'rigidly' the camera adheres to the 'rest' position of the chase view camera when doing maneuvers or changing speed.
*Syntax: '''''Float'''''
** Defaults to 5.0.}}

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

{{Table214|
===$Wingmen Gauge Dot Override:===
*(Optional) Defines an animation to use for the dots in the wingmen status gauge. Overrides 'Dot Filename:' under the '+Wingman Status:' entry in [[Hud_gauges.tbl#.2BWingman_Status:|Hud_gauges.tbl]]
*Must be an animation with two frames.
*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:===
{{Table250|
*Defines the alternative particle thruster.
*'''$Thruster Effect:''' OR '''$Afterburner Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be used for thruster and afterburner effects.
*Any number of thruster and afterburner particles can be specified here.
*Afterburner particles require at least 1 existing particle thruster entry.
*These can be used both instead and in combination with the legacy particles (''$Thruster Particle Bitmap:'', ''$Afterburner Particle Bitmap:'') described below
*Syntax: '''String''', the particle effect name
}}

{{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
{{Table212|
====+Alpha Decay Exponent:====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
====+Spew Time:====
*Time in milliseconds to create new trail points, lower means less 'jagged' trails.
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table212|
====+Bitmap Stretch:====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
{{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:'''
**Optional
**Rather than adding a new entry, an existing entry can be overriden by using its index in the list (starting at 0).
**Syntax: '''''Integer'''''
*'''+Used For:'''
{{Table230|
**This field may be omitted, and the activation of the thruster will be calculated automatically based on its position and direction.
}}
**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
***THESE NAMES MAY BE MISLEADING FOR YOU.
***'Roll left' and 'Roll right' are actually yaw, activated when the ship rotates around its top-bottom axis.
***'Bank left' and 'Bank right' are actually roll, activated when the ship rotates around its front-back axis.
{{Table232|
***'Yaw left' and 'Yaw right' are now valid strings for this field. 'Roll left' and 'Roll right' are still recognized for compatibility.
}}
**Syntax: '''''("String" "String")'''''
**Allows one or more strings, does not have a set limit.
*'''+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]]}}

===$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")'''
}}

===$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'''
{{Table220|
====+arrival rvec:====
*When using this path to arrive via fighterbay, the arriving 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 arrive via fighterbay.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}
====+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.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+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'''''
}}
}}

===$Passive Lightning Arcs:===
{{Table220|
*Creates a 'lightning arc' between two points on the ship's hull, like when the ship is EMP'd or damaged, but naturally and fixed to two points on the ship.
*This section can be repeated.
*'''All subfields are required'''
====+Submodel 1:====
*The name of the name of the submodel the first end is connected to.
*Note that the arc will ''not'' move along with a submodel while it is animating (but it will be initially created in the correct position). In the case of an animating submodel, it is recommended to use very short durations/frequencies.
**Syntax: '''''String'''''
====+Position 1:====
*The position on the ship this end is attached to, relative to the origin of the entire ship.
**Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+Submodel 2:====
====+Position 2:====
*The same as the above for the other end of the arc.
====+Duration:====
*How long the arc persists while active.
**Syntax: '''''Float''''', seconds
====+Frequency:====
*How long after creating an arc it should wait before creating another.
**Syntax: '''''Float''''', seconds}}
{{Table224|
====+Primary color 1:====
*The first primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Primary color 2:====
*The second primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Secondary color:====
*The secondary color of the arc. This is the inner color, usually close to white.
**Syntax: three '''''Integers''''', 0-255}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations, replacing the subsystem-based definitions
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Animations:===
{{Table240|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven animations '''are not''' compatible with $Animations! If you need animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

===$Animation Moveables:===
{{Table220|
*Like $Animations: but for specific in-mission adjustable moveable animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this ship class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Ship Class to find the CustomData Lua Table.
====+Val:====

Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.
====$end_custom_data====

Mandatory entry to indicate that the Custom Data list has ended. }}

===$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" or "support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly

===="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
*By default, the ship's subsystems are scannable (this can be overridden by mission designers)
*The ship will warp out without ramping up to warpout speed
*When using the "Knossos" warpout, this ship will aim for the center of the portal

===="supercap" or "super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true
**Ship subsystems are scannable by default (can be overridden by mission designers)
**The ship does not need to ramp up to warpout speed before entering subspace
**When using the "Knossos" warpout, the ship will aim for a departure point at the center of the Knossos portal

===="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" or "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" or "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" or "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-targetable, and not on radar.}}

===="no type"====
*Does not enable any type-specific behavior

----
==="ship copy"===
*Defines the ship as a copy of another ship. For ships which have this flag and are a hash-variant of another ship (like '''SF Dragon''' and '''SF Dragon#2 (Weakened)'''), the ship copy will be listed on the scoreboard as the original ship. This only affects the listing, not the score.

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

==="don't collide invisible" or "dont collide invisible"===
*Defines invisible textures as non-collidable (For example, a hangar entrance)

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

==="no_fred"===
*Ship will not appear in any of the FRED dropdown lists for ship classes.

==="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 modelled 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 shield icon from the model itself}}

===no weapon damage scaling"===
{{Table3610|
*Weapons that impact this ship will not by scaled according to 'big damage' or supercap rules}}

==="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}}

==="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 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}}

==="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:|$Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==="repair disabled subsystems"===
{{Table371|
Destroyed subsystems will auto-repair, provided [[Ships.tbl#.24Subsystem_Repair_Rate:|$Subsystem Repair Rate:]] is greater than 0. }}

==="don't bank when turning"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: the ship will not bank when changing its heading.}}

==="don't clamp max velocity"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: the ship's velocity will not be limited by its tabled max velocity, provided the max velocity is greater than 0. Use with caution!}}

==="instantaneous acceleration"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: whenever the ship decides to change speed, it will instantaneously reach its desired speed.}}

==="large ship deathroll"===
{{Table210|
Causes the ship to deathroll like a fighter, even if it is big or huge (which is disabled by default). Note that their deathroll intensity is scaled down by being larger size. }}

==="no impact debris"===
{{Table212|
Turns off the tiny debris shards that are typically spawned when something impacts a ship. }}

==Wing Formations==
===$Name:===
{{Table202|
*Provides a unique name for the formation, followed by the list of positions occupied by each member of the wing relative to their leader. The leader is always at 0,0,0 and is omitted, so the first position is the second in the wing, and second is the third in the wing, etc. Each formation must contain all 5 positions.
*NOTE: FSO automatically scales these these positions by the ship's size, so the table values will be very small. You can see the retail formation's values below for reference.
*Syntax: (a list of 5 '''''Vectors'''''), each has three '''floats''', x-axis, y-axis, z-axis, respectively}}

===Example===

<pre>
#Wing Formations

$Name: Default
((-0.39, 0.20, -0.59)
( 0.39, 0.20, -0.59)
(-0.78, 0.39, -1.18)
( 0.00, 0.39, -1.18)
( 0.78, 0.39, -1.18))

#End
</pre>

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

2025-07-09T08:38:36Z

Lafiel: /* Ships Table Options */

{{TableVersionGit|2024-11-13|d6b444c}}
{{Tables}}
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

See the article [[Subsystem]] for ship table information that is specific to subsystems.

==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.
{{Table202|
:*<nowiki>#</nowiki>'''Wing Formations'''
:**Includes the list of custom wingmate formations}}
:*'''$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]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in ships.tbl or in earlier parsed *-shp.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

===$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
*This setting does nothing
*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, when originally introduced, caused crashes and memory issues. Between 2014/07/24 and 2015/8/20, it was removed from the codebase. In short: do not use in versions prior to 3.7.4.}}
{{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}}

===+Use Ship as Template:===
{{Table232|
*Creates a copy of the specified ship to use as a base for this ship.
*'''''Caution!''''' This is highly dependent on the order the tables are loaded. If the ship used as a template is modified using <tt>+nocreate</tt>, the tabled changes will only be applied to the newly created ship if they are loaded ''before'' <tt>+Use Ship as Template</tt>. Any <tt>+nocreate</tt> changes ''after'' <tt>+Use Ship as Template</tt> will not have any effect on the newly created ship class. Thus, proper templates should be preferred if possible.
*Cannot be used in conjunction with <tt>+Use Template</tt>.
*Syntax: '''''String''''', name of the ship class to use as a template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship. Used to rename ships without breaking missions.
*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 -ship_choice_3d commandline flag is enabled or no ani can be found for the selected ship.
*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 Animations:===
{{Table230|
*Allows specifying animations that only run on the cockpit model of a ship
*See [[#$Animations:|$Animations]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Cockpit Animations:===
{{Table242|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven cockpit animations '''are not''' compatible with $Cockpit Animations! If you need cockpit animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

===$Cockpit Moveables:===
{{Table230|
*Allows specifying moveables that only run on the cockpit model of a ship
*See [[#$Moveables:|$Moveables]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

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

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*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:===
NOTE: this option has done nothing since before 2008

*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 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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used on weapon impact,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Spew'' is not a valid option!
}}

===$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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used for the smoke of a weapon impact,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Damage Spew'' is not a valid option!
*Note that the scaling applied by ''$Damage Spew'' '''is not''' applied to''$Damage Spew Effect:'' automatically. If desired, it has to be manually added using ''$Particle Source Curve:'' within the particle definition
}}

===$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).
}}
{{Table202|
====+Collision Sound Light:====
Sound when this ship collides normally.
====+Collision Sound Heavy:====
Sound when this ship collides at high speed.
====+Collision Sound Shielded:====
Sound when this ship collides with shields active.
}}

===$Gravity Const:===
{{Table224|
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship.
**Note that due to the exponential damping from $Damp, the acceleration from gravity will eventually even out with $Damp and result in a constant velocity in the direction of gravity.
**Syntax: '''''Float'''''}}

===$Dying Gravity Const:===
{{Table224|
**Same as above, but while ths ship is dying/in death roll.
**The aforementioned exponential damp is still in effect during this time, but it is weaker.
**Syntax: '''''Float'''''
**Default: The same as $Gravity Const:}}

===$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'''''}}
{{Table250|
*'''+Hitpoints Radius Multiplier:'''
**Defines the hitpoints multiplier. By default this is -1 and thus disabled, but if set to a value greater than or equal 0, the debris hitpoints will be multiplied by this value and the radius of the debris submodel. Useful for making debris have hitpoints that vary based on size of the debris piece.
**Syntax: '''''Float'''''
}}
{{Table3611|
*'''+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}}
{{Table224|
*'''+Debris Gravity Const:'''
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship's debris.
**Syntax: '''''Float'''''
**Default: The same as $Dying Gravity Const}}
{{Table232|
*'''+Debris Density:'''
**Same as [[Ship.tbl#$Density:|Density]] but only applied to the ship's debris.
**Syntax: '''''Float'''''
**Default: 1.0}}
{{Table202|
*'''+Ambient Sound:'''
**The sound played in the vicinity of debris.}}
{{Table212|
*'''+Generic Debris POF file:'''
**The filename of the ship's generic debris, by default debris01.pof.
**Big or huge ships do not normally have generic debris, but if this is specified for them, they will generate generic debris on explosion.
**Syntax: '''''String'''
*'''+Generic Debris Spew Num:'''
**How many generic debris fragments to generate when the ship explodes.
**If this is a big or huge ship, this is the number of generic debris fragments to generate for every individual propagating explosion.
**Syntax: '''''Integer'''
**Default: ''20''}}

===$Density:===
*Multiplies the mass and moment of inertia of the relevant ship.
*Ships with a high mass and moment of inertia will be moved/rotated by collisions and impacts less strongly.
*Syntax: '''''Float''''', usually 1. Must not be 0.

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

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.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), but only for the player, the AI will act as though it is still 0.
*Syntax: '''''Float'''''
*Defaults to 0.}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode.
**If > 0, sets a fixed acceleration rate in glide mode: ships will accelerate at their tabled maximum velocity along the given axis, interpreted in m/s^2, multiplied by ''+Glide Accel Mult:''.
**If set to 0, impossible to accelerate while in glide mode.
**If negative, enables glide speed ramping: acceleration in glide mode ramps using the same constants as in normal flight. Note, however, that glide acceleration ignores the ship's ''$Damp:'' value, so glide acceleration will always be faster than in normal flight; and if the damping constant is significantly larger than the acceleration constant along a given axis, this difference will become very pronounced.
*Syntax: '''''Float'''''
*Default: ''0''}}
{{Table3610|
*Entry exists as a dummy entry which doesn't 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}}

===+Primary Bank Autoaim FOV:===
{{Table232|
*Defines the autoaim for the primary bank.
*Can be listed once for each existing bank on the ship.
*Syntax: '''''Float'''''}}

===$Aims at Flight Cursor:===
{{Table242|
*Enables flight cursor-style flying for the ship, and causes the ship to fire in the direction of the cursor.
*'''Note:''' Only works for players! AI may need a system like autoaim to mimic it.
*Syntax: '''''Boolean'''''}}

===+Extent:===
{{Table242|
*Required if the above is true.
*How many degrees away from the center the player is allowed to shoot, using the flight cursor.
*Syntax: '''''Float''''', degrees}}

===$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|
:*''[Fireball Unique ID]'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*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}}

===$Supercap warpin physics:===
{{Table234|
*Specifies whether this ship should use supercap deceleration when arriving, similar to the Colossus. Can also disable supercap deceleration on a ship that normally has it.
*Syntax: '''''Boolean'''''}}

===$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|
:*''[Fireball Unique ID]'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*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, [[Game_settings.tbl#.24Minimum player warpout time:|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}}

===$Supercap warpout physics:===
{{Table234|
*Specifies whether this ship should use special physics when departing, as a complement to $Supercap warpin physics. Currently has no effect.
*Syntax: '''''Boolean'''''}}

===$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 has many smaller explosions while in its death-roll. Also determines whether the ship splits in two or not unless explicitly set below.
*Syntax: '''''Boolean''''', yes or no

===$Expl Splits Ship:===
{{Table202|
*Whether the ship splits in two and slowly explodes outward towards its front and back, or just immediately explodes into debris.
*Syntax: '''''Boolean''''', yes or no, defaults to the value of '$Expl Propagates:' above}}

===$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}}

===$Death Roll Rotation Multiplier:===
{{Table202|
*Multiplies the strength of the rotation imparted by death-rolling.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used when a ship is splitting apart,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Splitting Particles'' is not a valid option!
}}

===$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 Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$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 Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be used when a knossos type object is dying.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Alternate Death Particles'' is not a valid option!
}}

===$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}}

===$Debris Flame Effect:===
{{Table250|
*Specifies the [[Particle Effects|particle effect]] which will be added to debris spawned from this ship.
*Syntax: '''String''', the particle effect name
}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]]. Note that this option is misleadingly named; "vaporization" usually refers to a ship exploding into tiny debris shards rather than hull chunks.
*Syntax: '''''Float''''', percent chance of instant explosion, 0 to 100}}
{{Table240|In version 24.0 and later, '''$Skip Death Roll Percent Chance:''' can be used as a more accurate alternative.}}

===$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}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the ship explosion shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$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 its 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 its 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 its 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)''
*Note: This requires the [[Weapons.tbl#.24External_Model_File:|$External_Model_File entry to be defined in weapons.tbl]]. Weapons without external models will revert to the standard behaviour.
*Behavior is as follows:
**If your bank carries fewer or as many missiles as the number of gunpoints on your bank, you will have exactly as many external model shown as you have missiles left in your bank (going in the order of gunpoints defined in the POF). External models will disappear when missiles are fired.
**If your bank carries more missiles than you have gunpoints in your bank, then external models will "recoil" (to simulate a reloading animation) every time you fire, and will disappear based on the % of missile left in the bank. Example: you have 2 gunpoints and 4 missiles, the first external model will disappear after you fire the second missile.
**If your weapon uses the [[Weapons.tbl#.22external_model_launcher.22|"external_model_launcher" flag]], then the model will be displayed on all gunpoints and will not recoil nor disappear when fired.}}

===$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.}}
}}

===$Allowed Firing Patterns for Dynamic Primary Linking:===
{{Table250|
*If the ship has dynamic primary linking enabled, defines the list of firing patterns which the player may cycle through using the appropriate control.
*This is optional. If not set, the only firing pattern available will be CYCLE FORWARD.
*Takes a list of patterns. The options are:
**'''CYCLE FORWARD''': Fires '''$Shots''' shots from the first '''$Shots''' gunpoints (starting at gunpoint 0), then from the next '''$Shots''' gunpoints, and so on.
**'''CYCLE REVERSE''': Same behavior as CYCLE FORWARD, but begins at the highest-numbered gunpoint and works downward.
**'''RANDOM EXHAUSTIVE''': Fires '''$Shots''' shots at a time from randomly-selected gunpoints until each gunpoint has been fired once, and then starts over.
**'''RANDOM NONREPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time, but never fires the same gunpoint twice in a row (unless forced to because $Shots is equal to more than half the number of gunpoints).
**'''RANDOM REPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time. No restrictions.
*Syntax: '''String list''', for example, ("CYCLE FORWARD", "CYCLE REVERSE")}}

===$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}}

====+Max Shield Impact Effect Radius:====
{{Table250|
*Caps the size of the visual effect displayed on the shield mesh from impacts.
*Syntax: '''''Float''''', meters}}

===$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/afterburner energy regeneration is disabled. Checked via code inspection 2014-12-29
{{Table250|
If the current AI profile has the '''$ETS uses ship class power output:''' flag enabled, this will act as a multiplier for ETS energy. For example, a ship with a power output of 2 will recharge its afterburner twice as fast as a ship with the same stats but a power output of 1.
}}
*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''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===+Shield Regen Hit Delay:===
{{Table214|
*Specifies a time delay after being hit by a weapon before the shield may begin regenerating again.
*Syntax: '''''Float''''', seconds}}

===$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''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Shield to Weapon Transfer Quantity:===
{{Table202|
*The fraction of ''maximum'' shield capacity to use when making direct shield -> weapon energy transfers.
*Syntax: '''''Float'''''
**Default: ''0.2''
*'''Note:''' default direct transfers have a large and poorly-appreciated impact on ETS balancing. If you care about balancing your ship's weapon and shield recharge rates you are advised to set this to 0.}}

===$Shield to Weapon Transfer Efficiency:===
{{Table202|*The fraction of the transferred shield energy that will actually end up in the weapon capacitor.
*Syntax: '''''Float'''''
**Default: ''1.0''
*Note that the amount deposited will be absolute, not relative. For instance, for a ship with 100 weapon energy and 200 shields and default quantity and efficiency, a shield->weapon transfer will deduct 40 shield energy and add 40 weapon energy. It is entirely possible for efficiency to be more than 1.0.
*Unless transfer efficiency is tuned to account for the different charge rates for weapons and shields, direct transfers will tend to make the ETS unbalanced in the hands of an experienced player, as in retail.}}

===$Shield to Weapon Transfer Speed:===
{{Table202|*The rate at which transferred energy will move into the weapon capacitor,
*Syntax: '''''Float'''''
**Default:''0.04''
*When energy is transferred it is instantly deducted from shields, but it must 'trickle' into the weapon capacitor at a fixed fraction per second. This acts as a second bonus recharge on top of whatever the ETS produces.}}

===$Weapon to Shield Transfer Quantity:===

===$Weapon to Shield Transfer Efficiency:===

===$Weapon to Shield Transfer Speed:===

{{Table202|As above, but with the transfer direction reversed.}}

===$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''''', percentage of hitpoints repaired per second}}

===$Hull Self Repair Maximum:===
{{Table220|
*Maximum percentage of total hull strength that the hull will self-repair to.
*Syntax: '''''Float''''', percentage of hull hitpoints}}

===$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'', percentage of total subsystem hitpoints repaired per second}}

===$Subsystem Self Repair Maximum:===
{{Table220|
*Maximum percentage of total subsystem strength that subsystems will self-repair to.
*Syntax: '''''Float''''', percentage of subsystems hitpoints}}

===$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.
*Exact fuel recharged per second is given by the ETS value (as a percentage of total power output) multiplied by twice the tabled recharge rate, and then multiplied by the difficulty setting.
*Syntax: '''''Float''''', fuel units per second
====+Aburn Minimum Start Fuel:====
{{Table202|
*Minimum afterburner fuel the ship must have before allowed to afterburn.
*Syntax: '''''Float''''', fuel}}
====+Aburn Minimum Fuel to Burn:====
{{Table202|
*Forces the ship to afterburn until at least this much fuel is used, or it runs out of fuel.
*Syntax: '''''Float''''', fuel}}
====+Aburn Cooldown Time:====
{{Table202|
*How much time must have elapsed since the last afterburn finished to allow afterburning again.
*Syntax: '''''Float''''', seconds}}
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
{{Table212|
=====+Bitmap Stretch:=====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
=====+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'''''
{{Table212|
=====+Alpha Decay Exponent:=====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
{{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

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Scanning time multiplier:===
{{Table220|
*A factor to apply to scan time when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Scanning range multiplier:===
{{Table220|
*A factor to apply to scan distance when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$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]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by 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]]
}}

===$DeathRollSnd===
{{Table202|
*Optional sound to be used for the sound heard when the ship enters its death roll
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

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

===$SubsysExplosionSnd===
{{Table202|
*Optional sound to be used for the sound heard when a subsystem on this ship explodes
*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 and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

{{Table381|
===$Closeup_pos_targetbox:===
*Optional value to set for the position of the camera relative to the model in the HUD target box view. If not set then the value for $Closeup_pos: will be used.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom_targetbox:===
*Optional value to set how the model will show in the HUD target box view. How far the camera's zoomed in, defines camera's FOV. If not set then the value for $Closeup_zoom: will be used.
*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}}

===$Chase View Offset:===
{{Table214|
*Specifies a custom camera position when the ship is being viewed in the chase camera.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively in meters}}

===$Chase View Rigidity:===
{{Table214|
*Specifies how 'rigidly' the camera adheres to the 'rest' position of the chase view camera when doing maneuvers or changing speed.
*Syntax: '''''Float'''''
** Defaults to 5.0.}}

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

{{Table214|
===$Wingmen Gauge Dot Override:===
*(Optional) Defines an animation to use for the dots in the wingmen status gauge. Overrides 'Dot Filename:' under the '+Wingman Status:' entry in [[Hud_gauges.tbl#.2BWingman_Status:|Hud_gauges.tbl]]
*Must be an animation with two frames.
*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:===
{{Table250|
*Defines the alternative particle thruster.
*'''$Thruster Effect:''' OR '''$Afterburner Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be used for thruster and afterburner effects.
*Any number of thruster and afterburner particles can be specified here.
*Afterburner particles require at least 1 existing particle thruster entry.
*These can be used both instead and in combination with the legacy particles (''$Thruster Particle Bitmap:'', ''$Afterburner Particle Bitmap:'') described below
*Syntax: '''String''', the particle effect name
}}

{{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
{{Table212|
====+Alpha Decay Exponent:====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
====+Spew Time:====
*Time in milliseconds to create new trail points, lower means less 'jagged' trails.
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table212|
====+Bitmap Stretch:====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
{{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:'''
**Optional
**Rather than adding a new entry, an existing entry can be overriden by using its index in the list (starting at 0).
**Syntax: '''''Integer'''''
*'''+Used For:'''
{{Table230|
**This field may be omitted, and the activation of the thruster will be calculated automatically based on its position and direction.
}}
**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
***THESE NAMES MAY BE MISLEADING FOR YOU.
***'Roll left' and 'Roll right' are actually yaw, activated when the ship rotates around its top-bottom axis.
***'Bank left' and 'Bank right' are actually roll, activated when the ship rotates around its front-back axis.
{{Table232|
***'Yaw left' and 'Yaw right' are now valid strings for this field. 'Roll left' and 'Roll right' are still recognized for compatibility.
}}
**Syntax: '''''("String" "String")'''''
**Allows one or more strings, does not have a set limit.
*'''+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]]}}

===$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")'''
}}

===$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'''
{{Table220|
====+arrival rvec:====
*When using this path to arrive via fighterbay, the arriving 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 arrive via fighterbay.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}
====+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.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+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'''''
}}
}}

===$Passive Lightning Arcs:===
{{Table220|
*Creates a 'lightning arc' between two points on the ship's hull, like when the ship is EMP'd or damaged, but naturally and fixed to two points on the ship.
*This section can be repeated.
*'''All subfields are required'''
====+Submodel 1:====
*The name of the name of the submodel the first end is connected to.
*Note that the arc will ''not'' move along with a submodel while it is animating (but it will be initially created in the correct position). In the case of an animating submodel, it is recommended to use very short durations/frequencies.
**Syntax: '''''String'''''
====+Position 1:====
*The position on the ship this end is attached to, relative to the origin of the entire ship.
**Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+Submodel 2:====
====+Position 2:====
*The same as the above for the other end of the arc.
====+Duration:====
*How long the arc persists while active.
**Syntax: '''''Float''''', seconds
====+Frequency:====
*How long after creating an arc it should wait before creating another.
**Syntax: '''''Float''''', seconds}}
{{Table224|
====+Primary color 1:====
*The first primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Primary color 2:====
*The second primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Secondary color:====
*The secondary color of the arc. This is the inner color, usually close to white.
**Syntax: three '''''Integers''''', 0-255}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations, replacing the subsystem-based definitions
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Animations:===
{{Table240|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven animations '''are not''' compatible with $Animations! If you need animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

===$Animation Moveables:===
{{Table220|
*Like $Animations: but for specific in-mission adjustable moveable animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this ship class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Ship Class to find the CustomData Lua Table.
====+Val:====

Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.
====$end_custom_data====

Mandatory entry to indicate that the Custom Data list has ended. }}

===$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" or "support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly

===="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
*By default, the ship's subsystems are scannable (this can be overridden by mission designers)
*The ship will warp out without ramping up to warpout speed
*When using the "Knossos" warpout, this ship will aim for the center of the portal

===="supercap" or "super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true
**Ship subsystems are scannable by default (can be overridden by mission designers)
**The ship does not need to ramp up to warpout speed before entering subspace
**When using the "Knossos" warpout, the ship will aim for a departure point at the center of the Knossos portal

===="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" or "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" or "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" or "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-targetable, and not on radar.}}

===="no type"====
*Does not enable any type-specific behavior

----
==="ship copy"===
*Defines the ship as a copy of another ship. For ships which have this flag and are a hash-variant of another ship (like '''SF Dragon''' and '''SF Dragon#2 (Weakened)'''), the ship copy will be listed on the scoreboard as the original ship. This only affects the listing, not the score.

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

==="don't collide invisible" or "dont collide invisible"===
*Defines invisible textures as non-collidable (For example, a hangar entrance)

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

==="no_fred"===
*Ship will not appear in any of the FRED dropdown lists for ship classes.

==="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 modelled 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 shield icon from the model itself}}

===no weapon damage scaling"===
{{Table3610|
*Weapons that impact this ship will not by scaled according to 'big damage' or supercap rules}}

==="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}}

==="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 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}}

==="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:|$Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==="repair disabled subsystems"===
{{Table371|
Destroyed subsystems will auto-repair, provided [[Ships.tbl#.24Subsystem_Repair_Rate:|$Subsystem Repair Rate:]] is greater than 0. }}

==="don't bank when turning"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: the ship will not bank when changing its heading.}}

==="don't clamp max velocity"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: the ship's velocity will not be limited by its tabled max velocity, provided the max velocity is greater than 0. Use with caution!}}

==="instantaneous acceleration"===
{{Table210|All maneuvers by this ship class will have the same effect as the equivalent flag in <tt>ship-maneuver</tt>: whenever the ship decides to change speed, it will instantaneously reach its desired speed.}}

==="large ship deathroll"===
{{Table210|
Causes the ship to deathroll like a fighter, even if it is big or huge (which is disabled by default). Note that their deathroll intensity is scaled down by being larger size. }}

==="no impact debris"===
{{Table212|
Turns off the tiny debris shards that are typically spawned when something impacts a ship. }}

==Wing Formations==
===$Name:===
{{Table202|
*Provides a unique name for the formation, followed by the list of positions occupied by each member of the wing relative to their leader. The leader is always at 0,0,0 and is omitted, so the first position is the second in the wing, and second is the third in the wing, etc. Each formation must contain all 5 positions.
*NOTE: FSO automatically scales these these positions by the ship's size, so the table values will be very small. You can see the retail formation's values below for reference.
*Syntax: (a list of 5 '''''Vectors'''''), each has three '''floats''', x-axis, y-axis, z-axis, respectively}}

===Example===

<pre>
#Wing Formations

$Name: Default
((-0.39, 0.20, -0.59)
( 0.39, 0.20, -0.59)
(-0.78, 0.39, -1.18)
( 0.00, 0.39, -1.18)
( 0.78, 0.39, -1.18))

#End
</pre>

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

Particle Effects

2025-07-09T08:35:54Z

Lafiel: /* +Spawn Position Volume: */

Particle Effects

2025-07-09T08:29:27Z

Lafiel: /* $Effect: */

Particle Effects

2025-07-09T08:19:26Z

Lafiel: New particle curve inputs