FreeSpace Wiki - User contributions [en]

Armor.tbl

2012-10-14T08:21:02Z

Nuke: wrong starting symbol on +constant:, was $constant.

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

{{Table3615|
Note that this must be followed by a +Stored Value:, a +Constant:, or a +Value: tag. but only one of the three. This will be the value used by the calculation, so only one source is allowed.
}}
=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.
*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 is 100%
}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].
{{Table3615|
Note: As of this version +Value may be substituted with +Stored Value or +Constant. Usage of +Value in this section is only for example purposes and is a stand in for whatever source you actually use.
}}

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
{{Table3615|
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]
}}

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Armor.tbl

2012-08-29T22:25:12Z

Nuke: more clairification in calculation type list

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

{{Table3615|
Note that this must be followed by a +Stored Value:, a +Constant:, or a +Value: tag. but only one of the three. This will be the value used by the calculation, so only one source is allowed.
}}
=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.
*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 is 100%
}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].
{{Table3615|
Note: As of this version +Value may be substituted with +Stored Value or $Constant. Usage of +Value in this section is only for example purposes and is a stand in for whatever source you actually use.
}}

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
{{Table3615|
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]
}}

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Armor.tbl

2012-08-29T22:15:14Z

Nuke: clairification of alternate +value: sources

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

{{Table3615|
Note that this must be followed by a +Stored Value:, a +Constant:, or a +Value: tag. but only one of the three. This will be the value used by the calculation, so only one source is allowed.
}}
=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.
*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 is 100%
}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
{{Table3615|
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]
}}

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Armor.tbl

2012-08-29T22:01:58Z

Nuke: fixed glitch on entry +Shield Piercing Percentage: that caused the discription to not show

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.
*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 is 100%
}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
{{Table3615|
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]
}}

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Armor.tbl

2012-08-29T21:47:05Z

Nuke: marked new armor table features as 3.6.15 to clairify that they are not available in the 3.6.14 release candidates/builds (not that these features were available in some latter 3.6.13 nightlies)

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.

*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 = 100%}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
{{Table3615|
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]
}}

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Armor.tbl

2012-08-29T21:43:51Z

Nuke:

{{SCP_table}}

{{TableVersion|8629}}

The '''armor.tbl''' stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor. The reason for defining different damage types per armor is that armor may be damaged more/less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower but virtually none against bullets. 
It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be [[deprecated]] in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility if any mods or campaigns choose to make use of the table.

Please note that the spelling '''armour.tbl''' is currently not supported.

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

[[Tables|List of Tables]]

==#Armor Type==
Each armor entry begins with '''#Armor Type''' and ends with '''#End'''. There may be multiple entries in armor.tbl.

===$Name:===
Defines the name of the armor type. The same name must be used in the [[ships.tbl#$Armor Type:|$Armor Type]] entry in order for that ship to use the armor type. Note that Shields may also have an armor type as designated by [[ships.tbl#$Shield Armor Type:|$Shield Armor Type]]

*Syntax: '''String'''

===$Damage Type:===
Defines the name for the damage type that is used for the armor type/damage type pairs.
*The same name must be used in the [[weapons.tbl#$Damage Type:|$Damage Type]] entry (for all weapons that have this damage type) so that the armor can be applied against that particular damage type.
*Each $Damage Type entry must have at least one [[armor.tbl#+Calculation:|+Calculation]] entry

*Syntax:'''String''', name of the damage type

====+Calculation:====
Defines the used calculation type.
*Calculations per damage types are possible
*Calculations are performed in the order they are defined in the armor.tbl (and -amr.tbm's)
**The "current damage value" is the result of the calculation before it
**The "current damage value" is initially equal to the [[weapons.tbl#$Damage:|$Damage]] value of the weapon that is impacting the armor (provided that the weapon has the same [[armor.tbl#$Damage Type:|$Damage Type]])

*Syntax:'''String''', name of the calculation type
*Valid strings: see [[armor.tbl#List of Calculations|List of Calculations]]

=====+Stored Value:=====
{{Table3615|
The calculation shall use the value stored in the specified memory location (which is stored by a previous calculation)
*One, and only one, of the +Stored Value, [[armor.tbl#+Constant:|+Constant]], or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''Unsigned integer'''
*Valid Values: 0 through 7
**Values greater than 7 are possible, but are not guaranteed to work as of (Rev 8629)
}}

=====+Constant:=====
{{Table3615|
The calculation shall use a constant float value, that's internally defined in FSO.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], +Constant, or [[armor.tbl#+Value:|+Value]] entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax:'''String'''
*Valid Values:
**'''base damage'''
***The calculation shall use the base damage as defined by [[weapons.tbl#$Damage:|$Damage]]
***Note: if [[armor.tbl#+Difficulty Scale Type:|+Difficulty Scale Type]] is set to "first", this returns the base damage times the difficulty scale factor
**'''current damage'''
***The calculation shall use the resulting value of the previous calculation as the input value for this calculation
**'''difficulty factor'''
***The calculation shall use the difficulty scale factor
**'''random'''
***The calculation shall use a random number that's anywhere between 0 and 1
**'''pi'''
***The calculation shall use the constant Pi (3.1415...)
}}

=====+Value:=====
Defines the value used for the defined calculation.
*One, and only one, of the [[armor.tbl#+Stored Value:|+Stored Value]], [[armor.tbl#+Constant:|+Constant]], or +Value entries is required per [[armor.tbl#+Calculation:|+Calculation]].

*Syntax: '''Float'''

====+Shield Piercing Percentage:====
{{Table3611|
If a ship's shield is setup for this particular damage type (by using [[ship.tbl#$Shield Armor Type:|$Shield Armor Type]]), this entry defines the percentage of damage (resulting from the earlier calculations) that will be applied directly to the hull. This has the effect of damaging both the shield and hull for a single impact.

*Syntax: '''Float'''
*Valid values: '''0''' to '''1''', where 1 = 100%}}

====+Weapon Piercing Effect Start Limit:====
{{Table3612|
Defines the percentage of hull integrity at which weapon piercing effects are started

*Syntax: '''''Float''''', value from 0 to 100}}

====+Weapon Piercing Type:====
{{Table3612|
Defines the piercing type to use

*Syntax: '''''String'''''
*Valid Values:
**'''none'''
**'''default'''
**'''retail'''}}

====+Difficulty Scale Type:====
{{Table3615|
Dictates how/when the Difficulty damage multiplier is applied to the end result of all calculations

*Syntax: '''String'''
*Valid Values:
**'''first''' - Difficulty damage multiplier is applied to the base damage before calculations
**'''last''' - Difficulty damage multiplier is applied to the result of the calculations
**'''manual''' - Difficulty damage multiplier is ignored, and is assumed to be handled elsewhere (such as in a LUA script or a sexp)
}}

===$Flags:===
{{Table3611|
Defines the flags affecting this armor type

*Syntax: ( '''''String''''' )
*Valid flags:
**'''ignore subsystem armor'''
***If set, FSO will use the hull's armor type against all damage to the subsystem, regardless of any armor type that the subsystem may have}}

==#End==
Each #Armor Type section must end with #End, no exceptions.

----

==List of Calculations==
The following is a list of valid strings to be used with [[armor.tbl#+Calculation:|+Calculation]].

*'''additive'''
**Adds [[armor.tbl#+Value:|+Value]] to the the current damage value
*'''multiplicative'''
**Multiplies the the current damage value by [[armor.tbl#+Value:|+Value]]
*'''exponential'''
**Raises the current damage value to the power of [[armor.tbl#+Value:|+Value]]
*'''exponential base'''
**Raises [[armor.tbl#+Value:|+Value]] to the power of the current damage value
*'''cutoff'''
**If the current damage value is '''''less''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''reverse cutoff'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is 0.
*'''instant cutoff'''
**If the current damage value is '''''less''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations
*'''instant reverse cutoff'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to 0 and the engine ignores all following calculations.
*'''cap'''
**If the current damage value is '''''greater''''' than [[armor.tbl#+Value:|+Value]], then the resulting damage value is [[armor.tbl#+Value:|+Value]].
*'''instant cap'''
**If the current damage value is '''''greater''''' than the specified amount, then the resulting damage value is set to [[armor.tbl#+Value:|+Value]] and the engine ignores all following calculations.
*'''set'''
**Sets the damage value to [[armor.tbl#+Value:|+Value]].
*'''store'''
**Stores the current damage value to a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''load'''
**Loads the current damage value from a memory location specified by [[armor.tbl#+Value:|+Value]] (which is casted as an unsigned integer)
**Stored damage values may be used only in the calculations they are assigned, and are discarded after the calculations are finished
*'''random'''
**Randomizes the damage value to anything between the current damage value and the base damage value as defined by [[weapons.tbl#$Damage:|$Damage]]

==Example==
'''''[[armor.tbl]]'''''

<pre>
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End
</pre>

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
<pre>
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")
</pre>

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[GTW Subach HL-7|Subach HL-7]], and the "Kinetic" damage type to the [[GTM MX-64|Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9
</pre>

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
<pre>
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1
</pre>

Now, if you were to start ''FreeSpace 2'' with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[GTW Subach HL-7|Subach HL-7]], 1/3 more damage from the [[GTM MX-64|Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.

[[Category:Tables]]

Engine limitations

2012-06-28T11:22:26Z

Nuke:

The maximum numbers of certain types of entities that can exist in the FS2_Open engine. Please note that 'Inferno' refers to INF builds, which are standard from 3.6.12 on.

==General==
The overall limits of the various subsystem managers.
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505;"| '''Limit'''
|- align="center"
| Textures
| 4750
|- align="center"
| Sound tracks
| 30
|- align="center"
| Sounds
| No Limit
|}

==Tables==
The maximum types of an entity that can exist in the table

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| rowspan=2 style="background:#351515; width:150px"| '''Name'''
| colspan=2 style="background:#300505;"| '''Limit'''
|- align="center"
| style="background:#300505; width:75px"| '''Standard'''
| style="background:#300505; width:75px"| '''Inferno'''
|- align="center"
| [[Ships.tbl|Ship Classes]]
| 130
| 250
|- align="center"
| [[Weapons.tbl|Weapon Classes]]
| 200
| 300
|- align="center"
| Beam Sections
| colspan=2| 5
|- align="center"
| Pspews Per Weapon
| colspan=2| 4
|- align="center"
| [[Objecttypes.tbl|Object Types]]
| colspan=2| 16
|- align="center"
| [[Iff_defs.tbl|IFFs]]
| colspan=2|10
|- align="center"
| [[Ai_profiles.tbl|AI Profiles]]
| colspan=2| 5
|- align="center"
| [[Hud_gauges.tbl|Hud Gauges]]
| colspan=2| 64
|- align="center"
| [[Species.tbl|Intelligence Entries]]
| colspan=2| 75
|- align="center"
| Debriefing
| colspan=2| 2,000 Characters per Stage
|}

Please Note - Although not hardcoded, there are limits to the numbers of [[Modular Tables|‎ .tbm files]] that the game will recognize.

==Objects==
The maximum number of objects that can exist in a mission at any given time (except for ships and waypoints, which apply to the whole mission).

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Objects
| 2000
|- align="center"
| Ships
| 400
|- align="center"
| Weapons
| 700
|- align="center"
| Beams
| 500
|- align="center"
| Waypoints Per Path
| 20
|- align="center"
| Waypoint Paths
| 32
|}

==Wings==
The maximum number wings or ships in a wing that can exist

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Wings
| 75
|- align="center"
| Ships per Wing
| 6
|- align="center"
| Starting Wings
| 3
|- align="center"
| Squadron Wings
| 5
|- align="center"
| TvT Teams
| 2
|- align="center"
| TvT Wings per Team
| 1
|- align="center"
| TvT Wings
| 2
|}

==Models==
The maximum number of models that can exist at one time

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| rowspan=2 style="background:#351515; width:150px"| '''Name'''
| colspan=2 style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| style="background:#300505; width:75px"| '''Standard'''
| style="background:#300505; width:75px"| '''Inferno'''
|- align="center"
| Polygon Models
| 128
| 300
|}

The maximum number of a certain entity that can exist within a model

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Textures
| 64
|- align="center"
| Ship Primary Banks
| 3
|- align="center"
| Ship Secondary Banks
| 4
|- align="center"
| Firing Points Per-Bank
| 25
|- align="center"
| Debris Chunks
| 64
|}

==Sub-Weapon Types==

The maximums for the sub types of weapons.

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Type'''
| style="background:#300505; width:75px"| '''Max Instances'''
|- align="center"
| Corkscrew Missiles
| 64
|- align="center"
| Swarm Missiles
| 100
|}

[[Category:Source Code Project]]
[[Category:Modding]]

Script - Hud Pong

2011-02-17T20:53:47Z

Nuke: /* Table Entry */

Creates a special hud gauge that allows you to play pong. Use the mouse to manipulate the paddles.

==Table Entry==
<pre>#Global Hooks

$GameInit:

[

--HudPong (tm)
w = gr.getScreenWidth()
h = gr.getScreenHeight()

poneh = 0
ptwoh = 0
gameh = 300 --you can change this to what
gamew = 600 --ever resolution you want.
gamex = w / 2 --set what coords to draw
gamey = h / 2 --the game at here (game center).
ballx = gamex
bally = gamey
ballxvel = 1 --or change theese if you
ballyvel = 1 --want a faster ball speed
balla = 255
deathmsg = "Dont Loose Your Balls!"

drawpongarea = function(x, y, sx, sy) --pong box here
gr.setColor(0,200,0,255) --pong green
gr.drawLine(x-sx, y+sy, x+sx, y+sy)
gr.drawLine(x-sx, y-sy, x+sx, y-sy)
gr.setColor(0,100,0,20)
gr.drawRectangle(x-sx, y+sy, x+sx, y-sy) --now featuring a transparent back
end

drawpongpaddle = function(x, y)
gr.setColor(0,0,200,255)
gr.drawRectangle(x+5, y+15, x-5, y-15, true)
end

drawpongball = function(x, y, a)
gr.setColor(200,0,0,a)
gr.drawCircle(10,x,y)
end

--im nuts

]

$HUD:

[

--HudPong

drawpongarea(gamex,gamey,gamew/2,gameh/2) --draw playing area every frame

if w >= 1024 then --compensate for resolution
maxis1 = ((io.getMouseY() / 768) * (gameh * 0.9)) --paddels, what a mess, my math sucks
maxis2 = ((io.getMouseX() / 1024) * (gameh * 0.9))
else
maxis1 = ((io.getMouseY() / 480) * (gameh * 0.9)) --paddels, what a mess, my math sucks, now in lowres!
maxis2 = ((io.getMouseX() / 640) * (gameh * 0.9))
end

poneh = (maxis1 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
ptwoh = (maxis2 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
drawpongpaddle(gamex + (gamew/2) - 5, poneh)
drawpongpaddle(gamex - (gamew/2) + 5, ptwoh)

ballx = ballx + ballxvel --move and draw the ball
bally = bally + ballyvel
drawpongball(ballx, bally, balla)

if bally < (gamey - (gameh / 2)) + 5 or bally > (gamey + (gameh / 2)) - 5 then
ballyvel = ballyvel * -1 --bounce off borders
end

if ballx < (gamex - (gamew / 2)) or ballx > (gamex + (gamew / 2)) then --tell the player when he gets castrated and reset the game
gr.setColor(200,200,200,255)
gr.drawString(deathmsg, gamex - (gr.getStringWidth(deathmsg) / 2) , gamey)
balla = balla - 8
if balla < 1 then
ballx = gamex
bally = gamey
balla = 255
end
end

if (ballx < (gamex - (gamew / 2)) + 15 and bally > ptwoh - 15 and bally < ptwoh + 15) or (ballx > (gamex + (gamew / 2)) - 15 and bally > poneh - 15 and bally < poneh + 15) then
ballxvel = ballxvel * -1 --bounce off paddles
end

--nuts indeed

]

#End</pre>

==Notes==
This gives an example of how to handle multiple resolutions. It's also a good introduction to using the mouse in a hud script.

[[Category:Scripting Examples|Hud Pong]]

Weapons.tbl

2011-02-04T17:35:45Z

Nuke: /* $Pspew: */

{{Fileversion|6978}}

==Special Case Weapons==
===Beam Cannons===
*'''REQUIRES: "beam" flag'''
*'''REQUIRES: [[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''
===Flak Guns===
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Does not use any model or weapon effect though model must be defined, usually Hornet.pof. Instead it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails can also be added.

==Weapons Table==

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

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

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610| }}

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

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

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen and in Tech Room for the weapon.
*Syntax: '''''String.pof''''', model filename}}

===$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 targetting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the external weapon model
*Syntax: '''''Float'''''}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model
*Syntax: '''''Float'''''}}

===@Laser Bitmap:===
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: '''''String''''', filename

===@Laser Glow:===
**The graphic file that determines the glow of the weapon effect if no model is defined. The color in which this gets drawn is determined by @Laser Color and @Laser Color2.
**Syntax: '''''String''''', filename

===@Laser Color:===
**The color of the glow effect when you fire the weapon.
**Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''250, 0, 0''

===@Laser Color2:===
**The color of the glow effect at the weapon's maximum range.
**Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''0, 0, 250''

===@Laser Length:===
**Length of the weapon effect.
**Syntax: '''''Float''''', meters

===@Laser Head Radius:===
**Width of the head of the weapon effect.
**Syntax: '''''Float''''', meters

===@Laser Tail Radius:===
**Width of the tail of the weapon effect.
**Syntax: '''''Float''''', meters

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting 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
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage

===$Damage Type:===
{{Table3610|
*Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage. '''REQUIRES ADDITIONAL TABLE'''.
*Syntax: '''''String''''', name of the damage type as defined in [[armor.tbl]]}}

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

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves
*Syntax: '''''Float''''', damage}}

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

===$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.
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

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

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

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

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

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

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

===$Homing:===
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*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:'''
**Defines how well missile maneuvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missile's centerline.
**Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

*'''+Min Lock Time:'''
**'''For aspect/javelin missiles only''', the minimum number of seconds to gain target lock
**Syntax: '''''Float''''', seconds
*'''+Lock Pixels/Sec:'''
**'''For aspect/javelin missiles only''', 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''', 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 ????
**Syntax: '''''Integer''''', pixels
{{Table3610|
*'''+Seeker Strength:'''
**Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
**Syntax: '''''Float''''', seeker strength}}
{{Table3611|
*'''+Target Lead Scaler:'''
**Defines the type of pursuit course the missile tries to obtain.
**Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
**Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150}}

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

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

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters

===$Dinky impact explosion:===
{{Table3610|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky impact explosion radius:===
{{Table3610|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

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

===$EMP Intensity:===
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit
**Syntax: '''''Float'''''

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit
**Syntax: '''''Float'''''

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

*''WARNING: Putting +Old Style doesn't seem to work either.
To have a working electronics weapon just put the electronics flag in the weapon and make sure it has a big shockwave radius and a shockwave speed of 0.''
}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targetting beam that doesn't seem to have much of an effect on anything. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**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
:**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
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tileing factor. Second number defines the tileing type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number:
*Syntax: '''''Integer'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
*Defines a pattern of ammo to substitute for primary or secondary weapons. '''$substitute:''' can be repeated any number of times. ''+frequency'' and ''+index'' will grow the pattern array anytime something does not fit so any whole number will be accepted.
**Syntax: '''''Weapon Name'''''
*'''+frequency:'''
*Substitute '''Weapon Name''' every ''frequency'' shots. '''Mutually exclusive with ''+index'''''
**Syntax: '''''Positive Integer'''''
*'''+offset:'''
*Shift frequency pattern ''offset'' shots. '''Must be used with ''+frequency'''''
**Syntax: '''''Positive Integer'''''
*'''+index:'''
*Substitute the '''Weapon Name''' at ''index'' in the shot pattern. '''Mutually exclusive with ''+frequency'''''
**Syntax: '''''Positive Integer'''''
}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

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

2011-02-04T17:34:50Z

Nuke: /* $Pspew: */

{{Fileversion|6978}}

==Special Case Weapons==
===Beam Cannons===
*'''REQUIRES: "beam" flag'''
*'''REQUIRES: [[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''
===Flak Guns===
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Does not use any model or weapon effect though model must be defined, usually Hornet.pof. Instead it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails can also be added.

==Weapons Table==

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

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

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610| }}

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

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

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen and in Tech Room for the weapon.
*Syntax: '''''String.pof''''', model filename}}

===$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 targetting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the external weapon model
*Syntax: '''''Float'''''}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model
*Syntax: '''''Float'''''}}

===@Laser Bitmap:===
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: '''''String''''', filename

===@Laser Glow:===
**The graphic file that determines the glow of the weapon effect if no model is defined. The color in which this gets drawn is determined by @Laser Color and @Laser Color2.
**Syntax: '''''String''''', filename

===@Laser Color:===
**The color of the glow effect when you fire the weapon.
**Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''250, 0, 0''

===@Laser Color2:===
**The color of the glow effect at the weapon's maximum range.
**Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''0, 0, 250''

===@Laser Length:===
**Length of the weapon effect.
**Syntax: '''''Float''''', meters

===@Laser Head Radius:===
**Width of the head of the weapon effect.
**Syntax: '''''Float''''', meters

===@Laser Tail Radius:===
**Width of the tail of the weapon effect.
**Syntax: '''''Float''''', meters

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting 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
*Syntax: '''''Float''''', seconds

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: '''''Float''''', damage

===$Damage Type:===
{{Table3610|
*Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage. '''REQUIRES ADDITIONAL TABLE'''.
*Syntax: '''''String''''', name of the damage type as defined in [[armor.tbl]]}}

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

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves
*Syntax: '''''Float''''', damage}}

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

===$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.
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Syntax: '''''Float''''', meters

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

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

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

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

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

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

===$Homing:===
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*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:'''
**Defines how well missile maneuvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missile's centerline.
**Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option.}}

*'''+Min Lock Time:'''
**'''For aspect/javelin missiles only''', the minimum number of seconds to gain target lock
**Syntax: '''''Float''''', seconds
*'''+Lock Pixels/Sec:'''
**'''For aspect/javelin missiles only''', 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''', 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 ????
**Syntax: '''''Integer''''', pixels
{{Table3610|
*'''+Seeker Strength:'''
**Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
**Syntax: '''''Float''''', seeker strength}}
{{Table3611|
*'''+Target Lead Scaler:'''
**Defines the type of pursuit course the missile tries to obtain.
**Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
**Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150}}

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

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

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

===+Weapon Range:===
*Defines the range to the target where the weapons under AI will start firing.
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters

===$Dinky impact explosion:===
{{Table3610|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky impact explosion radius:===
{{Table3610|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

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

===$EMP Intensity:===
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit
**Syntax: '''''Float'''''

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit
**Syntax: '''''Float'''''

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

*''WARNING: Putting +Old Style doesn't seem to work either.
To have a working electronics weapon just put the electronics flag in the weapon and make sure it has a big shockwave radius and a shockwave speed of 0.''
}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===
{{Table3610|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', meters
***Default: 300}}

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targetting beam that doesn't seem to have much of an effect on anything. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**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
:**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
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tileing factor. Second number defines the tileing 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. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number:
*Syntax: '''''Integer'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Substitute:===
{{Table3613|
*Defines a pattern of ammo to substitute for primary or secondary weapons. '''$substitute:''' can be repeated any number of times. ''+frequency'' and ''+index'' will grow the pattern array anytime something does not fit so any whole number will be accepted.
**Syntax: '''''Weapon Name'''''
*'''+frequency:'''
*Substitute '''Weapon Name''' every ''frequency'' shots. '''Mutually exclusive with ''+index'''''
**Syntax: '''''Positive Integer'''''
*'''+offset:'''
*Shift frequency pattern ''offset'' shots. '''Must be used with ''+frequency'''''
**Syntax: '''''Positive Integer'''''
*'''+index:'''
*Substitute the '''Weapon Name''' at ''index'' in the shot pattern. '''Mutually exclusive with ''+frequency'''''
**Syntax: '''''Positive Integer'''''
}}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="capital+"===
{{Table3613|
*Tells AI to use this weapon only on capital ships}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Scripting.tbl

2010-03-02T12:13:03Z

Nuke: /* Format */

'''''This feature requires SCP''''' 

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located here: ''[[List of Game States]]''
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found here: ''[[List of Game States]]''
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the current mission's filename. (Also under consideration).
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 

===Actions===
;On Game Init: Executes immediately after game has been started.
::* No associated hook variables.
;On Splash Screen: Executes when initial game splash screen is shown
::* No associated hook variables.
;On State Start: Executed when specified game state starts
::* No associated hook variables.
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.
;On Key Pressed: Executed when specified key is pressed
::* '''Key''', The pressed key
;On Key Released: Executed when specified key is released
::* '''Key''', The released key
;On Mouse Moved: Executed when mouse is moved
::* No associated hook variables.
;On Mouse Pressed: Executed when mouse button is pressed
::* No associated hook variables.
;On Mouse Released: Executed when mouse button is released
::* No associated hook variables.
;On State End: Executed when specified game state ends
::* No associated hook variables.
;On Mission Start: Executed when mission starts
::* No associated hook variables.
;On HUD Draw: Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)
;On Weapon Collision: Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)
;On Debris Collision: Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)
;On Warp In:Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)
;On Warp Out: Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)
;On Death: On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists
;On Mission End: Run on mission end.
::* No associated hook variables.

;Other hook variables:
::* '''Viewer''', active if (non-player) viewing object is valid
::* '''Player''', active if player obj is valid
 
==Examples==
See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Scripting.tbl

2010-03-02T12:11:52Z

Nuke: /* Conditions */

'''''This feature requires SCP''''' 

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located [http://fs2source.warpcore.org/cgi-bin/cvsweb/cvsweb.cgi/fs2_open/code/gamesequence/gamesequence.h?rev=2.10&content-type=text/x-cvsweb-markup within a source code file.] Search for "GS_STATE_MAIN_MENU" and look for other "GS_STATE" text.
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found here: ''[[List of Game States]]''
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the current mission's filename. (Also under consideration).
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 

===Actions===
;On Game Init: Executes immediately after game has been started.
::* No associated hook variables.
;On Splash Screen: Executes when initial game splash screen is shown
::* No associated hook variables.
;On State Start: Executed when specified game state starts
::* No associated hook variables.
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.
;On Key Pressed: Executed when specified key is pressed
::* '''Key''', The pressed key
;On Key Released: Executed when specified key is released
::* '''Key''', The released key
;On Mouse Moved: Executed when mouse is moved
::* No associated hook variables.
;On Mouse Pressed: Executed when mouse button is pressed
::* No associated hook variables.
;On Mouse Released: Executed when mouse button is released
::* No associated hook variables.
;On State End: Executed when specified game state ends
::* No associated hook variables.
;On Mission Start: Executed when mission starts
::* No associated hook variables.
;On HUD Draw: Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)
;On Weapon Collision: Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)
;On Debris Collision: Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)
;On Warp In:Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)
;On Warp Out: Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)
;On Death: On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists
;On Mission End: Run on mission end.
::* No associated hook variables.

;Other hook variables:
::* '''Viewer''', active if (non-player) viewing object is valid
::* '''Player''', active if player obj is valid
 
==Examples==
See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

List of Game States

2010-03-02T12:09:47Z

Nuke: Created page with '===List of Game States=== ---- *NOT A VALID STATE *GS_STATE_MAIN_MENU *GS_STATE_GAME_PLAY *GS_STATE_GAME_PAUSED *GS_STATE_QUIT_GAME *GS_STATE_OPTIONS_MENU *GS_STATE_BARRACKS_MENU…'

===List of Game States===
----
*NOT A VALID STATE
*GS_STATE_MAIN_MENU
*GS_STATE_GAME_PLAY
*GS_STATE_GAME_PAUSED
*GS_STATE_QUIT_GAME
*GS_STATE_OPTIONS_MENU
*GS_STATE_BARRACKS_MENU
*GS_STATE_TECH_MENU
*GS_STATE_TRAINING_MENU
*GS_STATE_LOAD_MISSION_MENU
*GS_STATE_BRIEFING
*GS_STATE_SHIP_SELECT
*GS_STATE_DEBUG_PAUSED
*GS_STATE_HUD_CONFIG
*GS_STATE_MULTI_JOIN_GAME
*GS_STATE_CONTROL_CONFIG
*GS_STATE_WEAPON_SELECT
*GS_STATE_MISSION_LOG_SCROLLBACK
*GS_STATE_DEATH_DIED
*GS_STATE_DEATH_BLEW_UP
*GS_STATE_SIMULATOR_ROOM
*GS_STATE_CREDITS
*GS_STATE_SHOW_GOALS
*GS_STATE_HOTKEY_SCREEN
*GS_STATE_VIEW_MEDALS
*GS_STATE_MULTI_HOST_SETUP
*GS_STATE_MULTI_CLIENT_SETUP
*GS_STATE_DEBRIEF
*GS_STATE_VIEW_CUTSCENES
*GS_STATE_MULTI_STD_WAIT
*GS_STATE_STANDALONE_MAIN
*GS_STATE_MULTI_PAUSED
*GS_STATE_TEAM_SELECT
*GS_STATE_TRAINING_PAUSED
*GS_STATE_INGAME_PRE_JOIN
*GS_STATE_EVENT_DEBUG
*GS_STATE_STANDALONE_POSTGAME
*GS_STATE_INITIAL_PLAYER_SELECT
*GS_STATE_MULTI_MISSION_SYNC
*GS_STATE_MULTI_START_GAME
*GS_STATE_MULTI_HOST_OPTIONS
*GS_STATE_MULTI_DOGFIGHT_DEBRIEF
*GS_STATE_CAMPAIGN_ROOM
*GS_STATE_CMD_BRIEF
*GS_STATE_RED_ALERT
*GS_STATE_END_OF_CAMPAIGN
*GS_STATE_GAMEPLAY_HELP
*GS_STATE_END_DEMO
*GS_STATE_LOOP_BRIEF
*GS_STATE_PXO
*GS_STATE_LAB
*GS_STATE_PXO_HELP
*GS_STATE_START_GAME
*GS_STATE_FICTION_VIEWER"

Scripting.tbl

2010-03-02T12:03:44Z

Nuke:

'''''This feature requires SCP''''' 

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''

*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets specifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
Note that, as with other tables, the game expects these entries in precisely the order given here; if this is not followed, the parser will throw an error.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located [http://fs2source.warpcore.org/cgi-bin/cvsweb/cvsweb.cgi/fs2_open/code/gamesequence/gamesequence.h?rev=2.10&content-type=text/x-cvsweb-markup within a source code file.] Search for "GS_STATE_MAIN_MENU" and look for other "GS_STATE" text.
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.

===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:

===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found in the source, as part of [http://fs2source.warpcore.org/cgi-bin/cvsweb/cvsweb.cgi/fs2_open/code/gamesequence/gamesequence.h?rev=2.10&content-type=text/x-cvsweb-markup gamesequence.cpp]. Search this file for "GS_STATE" to find the list, or here '''[[List of Game States]]'''
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the current mission's filename. (Also under consideration).
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 
===Actions===
;On Game Init: Executes immediately after game has been started.
::* No associated hook variables.
;On Splash Screen: Executes when initial game splash screen is shown
::* No associated hook variables.
;On State Start: Executed when specified game state starts
::* No associated hook variables.
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn.
::* No associated hook variables.
;On Key Pressed: Executed when specified key is pressed
::* '''Key''', The pressed key
;On Key Released: Executed when specified key is released
::* '''Key''', The released key
;On Mouse Moved: Executed when mouse is moved
::* No associated hook variables.
;On Mouse Pressed: Executed when mouse button is pressed
::* No associated hook variables.
;On Mouse Released: Executed when mouse button is released
::* No associated hook variables.
;On State End: Executed when specified game state ends
::* No associated hook variables.
;On Mission Start: Executed when mission starts
::* No associated hook variables.
;On HUD Draw: Executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on
::* '''Self''', the viewer (object)
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
::* When colliding something other than other ship:
::** '''Ship''', the ship (object)
::** '''Debris''', '''Asteroid''', '''Weapon''', depending what it collided with (object)
::** '''Self''', the object referred by the condition (object)
::** '''Object''', the ship (object)
::* When colliding with other ship:
::** '''Ship''', the ship (object) referred by the condition (object)
::** '''ShipB''', the other ship (object)
::** '''Self''', the ship (object) referred by the condition (object)
::** '''Object''', the other ship (object)
;On Weapon Collision: Like the ship collision hook, but for weapons.
::* When colliding something other than other weapon:
::** '''Weapon''', the weapon (object)
::** '''Debris''', '''Asteroid''', '''Ship''', depending what it collided with (object)
::** '''Self''', the object the weapon collided with (object)
::** '''Object''', the weapon (object)
::* When colliding with other weapon:
::** '''Weapon''', the weapon (object) referred by the condition
::** '''WeaponB''', the other weapon (object)
::** '''Self''', the weapon (object) referred by the condition
::** '''Object''', the other weapon (object)
;On Debris Collision: Like the ship collision hook, except for debris.
::* '''Debris''', the debris (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the debris collided with (object)
::* '''Object''', the debris (object)
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
::* '''Asteroid''', the asteroid (object)
::* '''Weapon''', '''Ship''', depending what it collided with (object)
::* '''Self''', the object the asteroid collided with (object)
::* '''Object''', the asteroid (object)
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
::* '''Self''', the object rendered (object)
;On Warp In:Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
::* '''Self''', the object warping in (object)
;On Warp Out: Same as warping in, except for warping out.
::* '''Self''', the object warping out (object)
;On Death: On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
::* For asteroids:
::** '''Self''', the asteroid (object)
::* For ships:
::** '''Self''', the ship (object)
::** '''Killer''', the other object (object) - NOTE, not guaranteed to exists
;On Mission End: Run on mission end.
::* No associated hook variables.

;Other hook variables:
::* '''Viewer''', active if (non-player) viewing object is valid
::* '''Player''', active if player obj is valid
 
==Examples==
See [[:Category:Scripting Examples|Scripting Examples category]]

[[Category:Tables]]

Ships.tbl

2008-04-11T23:15:24Z

Nuke: /* $Banking Constant: */

{{TableVersion|4562|4499}}


==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.
{{Table37|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

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

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

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

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

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

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

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

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

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

===Example===

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

==Ship Template Options==
{{Table37|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

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

===+Use Template:===
{{Table37|
*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.
*Syntax: '''''String'''''', name

===+nocreate===
{{Table36|
*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:===
{{Table37|
*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}}

===$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.
{{Table36|
*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 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)

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

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

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

===$Texture Replace:===
{{Table36|
*'''+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:===
{{Table36|
*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. ''(We need a coder to post here the multiplier values that each level sets)''.
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

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

===$Show damage:===
*No known function. Best left alone to avoid possible compatibility issues.
*Syntax: '''''Boolean''''', yes or no, usually yes

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

===$Impact Spew:===
{{Table36|
*Used to define the impact particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 impact spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Damage Spew:===
{{Table36|
*Used to define the damage particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 damage spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Debris:===
{{Table36|
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table37|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris
**Syntax: '''''Float''''
*+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float''''
*+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float''''
*+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float''''
*+Min Rotation speed:
**Defines the minimum rotational speed of the debris
**Syntax: '''''Float''''
*+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float''''}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will severely damage your ship, and push the lower density object away; the higher the numbers are, the harder they will hit and the farther they will be pushed. Setting a density of 10 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid.
*Syntax: '''''Float''''', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

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

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

===$Rotation time:===
*Defines rotation times around the x, y, and z -axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second

===$Forward accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: '''''Float''''', seconds

===$Forward decel:===
*Number of seconds needed from maximum velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide accel:===
*Same for sliding as the $Forward accel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Slide decel:===
*Same for sliding as the $Forward decel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table36|
*Allows gliding in game, i.e. turning the ship's facing without changing its direction.
*Syntax: '''''Boolean''''', yes or no}}

===+Max Glide Speed:===
{{Table36|
*Defines the maximum glide speed if the glide has been enabled
*Syntax: '''''Float'''''}}

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

===$Warpin type:===
{{Table36|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
**''Default''
**''BTRL''
**''Homeworld''
**''Hyperspace''
*Syntax: '''''String'''''}}
{{Table37|
*Can be defined as:
**''Default''
**''BTRL''}}

===$Warpin speed:===
{{Table36|
*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:===
{{Table36|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

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

===$Warpin animation:===
{{Table36|
*Defines the animation used as the warpin effect.
*Syntax: '''''String''''', filename}}

===$Warpout type:===
{{Table36|
*Allow an animation to be defined as a warpout effect.
*Can be defined as ''BTRL'' or ''default''.
*Syntax: '''''String'''''}}

===$Warpout speed:===
{{Table36|
*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
*Syntax: '''''Float''''', meters per second or milliseconds}}

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

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

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

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

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

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

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

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

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

===$Shockwave Damage Type:===
{{Table36|
*'''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:===
{{Table36|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Weapon Model Draw Distance:===
{{Table36|
*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
{{Table36|
*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
{{Table36|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

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

====$PBank Capacity:====
{{Table36|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table36|
*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
{{Table36|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

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

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

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

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

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

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

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons recharge.
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table36|
*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''}}

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

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

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

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

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

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

===$Armor Type===
{{Table36|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for 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" )

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

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
*'''+Aburn Max Vel:'''
**Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
*'''+Aburn For accel:'''
**Defined only for the forward acceleration. In same format as $Forward accel:
**Syntax: '''''Float''''', seconds
*'''+Aburn Fuel:'''
**Amount of afterburner fuel the ship has
**Syntax: '''''Float''''', fuel
*'''+Aburn Burn Rate:'''
**Rate the fuel is consumed when afterburner is engaged (in units per seconds)
**Syntax: '''''Float''''', fuel units per second
*'''+Aburn Rec Rate:'''
**Rate the fuel is restored.
**Syntax: '''''Float''''', fuel units per second
{{Table36|
*'''$Trails:'''
**Allows afterburner trails to be used
**'''+Bitmap:'''
***Texture used to draw the afterburner trail
***Syntax: '''''String''''', filename
**'''+Width:'''
***Width of afterburner trail at the beginning of it (ie. the thruster end)
***Syntax: '''''Float''''', meters
**'''+Alpha:'''
***Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
***Syntax: '''''Float'''''
**'''+Life:'''
***How long the trail will last
***Syntax: '''''Float''''', seconds}}

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

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

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

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

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

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

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

===$Shield_icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table36|
*Reference to the hud.tbl is no longer needed.}}

*Syntax: ''Filename''

===$Ship_icon:===
*The icon used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

*Syntax: ''Filename''

===$Ship_anim:===
*The glowing green grid animation used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

*Syntax: '''''String''''', filename

===$Ship_overhead:===
*The overhead view used in the weapons loadout.
{{Table36|
*Ship model is used by default to generate the image.}}

*Syntax: '''''String''''', filename

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

===Customized Thruster Effects===
{{Table36|
*'''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'''''}}

===$Thruster Particles:===
{{Table36|
*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.
{{Table36|
This field is deprecated, and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max decals:===
{{Table36|
*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.}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
*'''+Offset:'''
**The position of the contrail's head
**Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
*'''+Start Width:'''
**The width of the contrail's head
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**The width of the contrail's tail
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the contrail's head
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the contrail's tail
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the contrail remains
**Syntax: '''''Float'''''', seconds
*'''+Spew Time:'''
**Syntax: '''''Integer'''''
*'''+Bitmap:'''
**The image to use for the contrail.
**Syntax: '''''String''''', filename

===$Thruster:===
{{Table36|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used for:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''String'''''}}
{{Table37|
*'''+Flags:'''
**Flags that modify thruster behavior. As of now, only "no scale" exists, which causes all thrusters to be displayed at the same size regardless of thrust amount.
**List of flags: no scale
**Syntax: ("'''''String'''''"), names of the flags}}
{{Table36|
*'''+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]]}}

===[[Subsystems|$Subsystem:]]===

==Ships.tbl flags==

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

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

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

----

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

----

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

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

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

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

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

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

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

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

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

==="show ship"===
{{Table36|
*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"===
{{Table36|
*Creates a HUD icon from the model itself}}

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

==="no primary linking"===
{{Table37|
*Prevents ships from linking primary weapons}}

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

Script - Hud Pong

2006-07-11T04:59:08Z

Nuke:

==Function==
Creates a special hud gauge that allows you to play pong. Use the mouse to manipulate the paddles.

==Table Entry==
<pre>#Global Hooks

$GameInit:

[

--HudPong (tm)
w = gr.getScreenWidth()
h = gr.getScreenHeight()

poneh = 0
ptwoh = 0
gameh = 300 --you can change this to what
gamew = 600 --ever resolution you want.
gamex = w / 2 --set what coords to draw
gamey = h / 2 --the game at here (game center).
ballx = gamex
bally = gamey
ballxvel = 1 --or change theese if you
ballyvel = 1 --want a faster ball speed
balla = 255
deathmsg = "Dont Loose Your Balls!"

drawpongarea = function(x, y, sx, sy) --pong box here
gr.setColor(0,200,0,255) --pong green
gr.drawLine(x-sx, y+sy, x+sx, y+sy)
gr.drawLine(x-sx, y-sy, x+sx, y-sy)
gr.setColor(0,100,0,20)
gr.drawRectangle(x-sx, y+sy, x+sx, y-sy) --now featuring a transparent back
end

drawpongpaddle = function(x, y)
gr.setColor(0,0,200,255)
gr.drawRectangle(x+5, y+15, x-5, y-15, true)
end

drawpongball = function(x, y, a)
gr.setColor(200,0,0,a)
gr.drawCircle(10,x,y)
end

--im nuts

]

$HUD:

[

--HudPong

drawpongarea(gamex,gamey,gamew/2,gameh/2) --draw playing area every frame

if w >= 1024 then --compensate for resolution
maxis1 = ((ms.getY() / 768) * (gameh * 0.9)) --paddels, what a mess, my math sucks
maxis2 = ((ms.getX() / 1024) * (gameh * 0.9))
else
maxis1 = ((ms.getY() / 480) * (gameh * 0.9)) --paddels, what a mess, my math sucks, now in lowres!
maxis2 = ((ms.getX() / 640) * (gameh * 0.9))
end

poneh = (maxis1 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
ptwoh = (maxis2 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
drawpongpaddle(gamex + (gamew/2) - 5, poneh)
drawpongpaddle(gamex - (gamew/2) + 5, ptwoh)

ballx = ballx + ballxvel --move and draw the ball
bally = bally + ballyvel
drawpongball(ballx, bally, balla)

if bally < (gamey - (gameh / 2)) + 5 or bally > (gamey + (gameh / 2)) - 5 then
ballyvel = ballyvel * -1 --bounce off borders
end

if ballx < (gamex - (gamew / 2)) or ballx > (gamex + (gamew / 2)) then --tell the player when he gets castrated and reset the game
gr.setColor(200,200,200,255)
gr.drawString(deathmsg, gamex - (gr.getStringWidth(deathmsg) / 2) , gamey)
balla = balla - 8
if balla < 1 then
ballx = gamex
bally = gamey
balla = 255
end
end

if (ballx < (gamex - (gamew / 2)) + 15 and bally > ptwoh - 15 and bally < ptwoh + 15) or (ballx > (gamex + (gamew / 2)) - 15 and bally > poneh - 15 and bally < poneh + 15) then
ballxvel = ballxvel * -1 --bounce off paddles
end

--nuts indeed

]

#End</pre>

==Notes==
This gives an example of how to handel multiple resolutions. Its also a good introduction to using the mouse in a hud script.

[[Category:Scripting Examples|Hud Pong]]

Script - Hud Pong

2006-07-11T04:57:55Z

Nuke:

Script - Hud Pong

2006-07-11T04:55:38Z

Nuke:

==Function==
Creates a special hud gauge that allows you to play pong.

==Table Entry==
<pre>#Global Hooks

$GameInit:

[

--HudPong (tm)
w = gr.getScreenWidth()
h = gr.getScreenHeight()

poneh = 0
ptwoh = 0
gameh = 300 --you can change this to what
gamew = 600 --ever resolution you want.
gamex = w / 2 --set what coords to draw
gamey = h / 2 --the game at here (game center).
ballx = gamex
bally = gamey
ballxvel = 1 --or change theese if you
ballyvel = 1 --want a faster ball speed
balla = 255
deathmsg = "Dont Loose Your Balls!"

drawpongarea = function(x, y, sx, sy) --pong box here
gr.setColor(0,200,0,255) --pong green
gr.drawLine(x-sx, y+sy, x+sx, y+sy)
gr.drawLine(x-sx, y-sy, x+sx, y-sy)
gr.setColor(0,100,0,20)
gr.drawRectangle(x-sx, y+sy, x+sx, y-sy) --now featuring a transparent back
end

drawpongpaddle = function(x, y)
gr.setColor(0,0,200,255)
gr.drawRectangle(x+5, y+15, x-5, y-15, true)
end

drawpongball = function(x, y, a)
gr.setColor(200,0,0,a)
gr.drawCircle(10,x,y)
end

--im nuts

]

$HUD:

[

--HudPong

drawpongarea(gamex,gamey,gamew/2,gameh/2) --draw playing area every frame

if w >= 1024 then --compensate for resolution
maxis1 = ((ms.getY() / 768) * (gameh * 0.9)) --paddels, what a mess, my math sucks
maxis2 = ((ms.getX() / 1024) * (gameh * 0.9))
else
maxis1 = ((ms.getY() / 480) * (gameh * 0.9)) --paddels, what a mess, my math sucks, now in lowres!
maxis2 = ((ms.getX() / 640) * (gameh * 0.9))
end

poneh = (maxis1 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
ptwoh = (maxis2 + (gamey - (gameh / 2))) + ((gameh - (gameh * 0.9)) / 2)
drawpongpaddle(gamex + (gamew/2) - 5, poneh)
drawpongpaddle(gamex - (gamew/2) + 5, ptwoh)

ballx = ballx + ballxvel --move and draw the ball
bally = bally + ballyvel
drawpongball(ballx, bally, balla)

if bally < (gamey - (gameh / 2)) + 5 or bally > (gamey + (gameh / 2)) - 5 then
ballyvel = ballyvel * -1 --bounce off borders
end

if ballx < (gamex - (gamew / 2)) or ballx > (gamex + (gamew / 2)) then --tell the player when he gets castrated and reset the game
gr.setColor(200,200,200,255)
gr.drawString(deathmsg, gamex - (gr.getStringWidth(deathmsg) / 2) , gamey)
balla = balla - 8
if balla < 1 then
ballx = gamex
bally = gamey
balla = 255
end
end

if (ballx < (gamex - (gamew / 2)) + 15 and bally > ptwoh - 15 and bally < ptwoh + 15) or (ballx > (gamex + (gamew / 2)) - 15 and bally > poneh - 15 and bally < poneh + 15) then
ballxvel = ballxvel * -1 --bounce off paddles
end

--nuts indeed

]

#End</pre>

==Notes==
This gives an example of how to handel multiple resolutions. Its also a good introduction to using the mouse in a hud script.

[[Category:Scripting Examples|Velocity Indicator]]

Scripting.tbl

2006-07-11T04:52:13Z

Nuke: /* Examples */

Animation Code

2006-06-18T11:17:57Z

Nuke:

Known commonly as Bob's animation code as the code was written by Bobboau. Enables submodels defined in [[ships.tbl]] or in any related modular table to be animated in game. Animation code is included to the subsystem entry in similar manner as with [[Animation_Code#Setting_Turret_Angle|multipart turrets]]

==Animation Class==
*Animation classes are defined in submodels description
*Syntax: '''$animation:''' ''Class''
*'''Triggered'''
**Currently only supported animation class

===Animation Type===
*Animation type defines when the animation is used
*Currently supported animation types:
**'''initial'''
***Animation code is started when the mission begins. Unlike other animation types this requires only '''angle''' to be set
**'''docking'''
***Animation code is started when ship starts docking
**'''docked'''
***Animation code is started when ship is docked
**'''primary_bank'''
***Animation code is started when a primary bank is selected (armed)
**'''secondary_bank'''
***Animation code is started when a secondary bank is selected (armed)
**'''door'''
***Animation code starts when ship launches or retrives others through it's fighterbay.
**'''afterburner'''
***Animation code is started when ships afterburner is engaged
**'''turret firing'''
***Animation code is started when selected turret is firing
**'''scripted'''
***Animation code is started when it is triggered with scripts (see [[scripting.tbl]])
*Syntax: '''$type:''' ''Type''

===Animation Sub-Type===
*Optional more accurate descriptor for the animation type
*'''primary bank''' or '''secondary bank'''
**Syntax: '''+sub_type:''' ''Value'', (0 = 1st weapon bank, 1 = 2nd weapon bank, etc.)
*'''turret firing'''
**Syntax: '''+sub_type:''' ''Value'', (model number of the turret that triggers the animation)

===Animation Code===
*'''+delay:'''
**Defines how long til the trigger starts.
**Syntax: ''Value'', (milliseconds)
*'''+reverse delay:'''
**
**Syntax: ''Value'', (seconds)
*'''+absolute angle:''' OR '''+relative angle:'''
**Defines the rotation degrees with three floats that give the x, y, and z. Absolute means in world terms; relative means relative to the ship. So a 90 degree angle on the ship would always be straight up in relative degrees; it would vary depending how the ship was rotated in absolute degrees.
**Syntax: ''Value,Value,Value'', (degrees)
*'''+velocity:'''
**Defines subobject rotation speed, in relative terms. Defined with x, y and z floats.
**Syntax: ''Value,Value,Value'', (meters)
*'''+acceleration:'''
**Defeines acceleration speed of subobject rotation. Defined with three floats, x, y and z
**Syntax: ''Value,Value,Value''
*'''+time:'''
**Defines time for object to rotate, move, whatever.
**Syntax: ''Value'', (milliseconds)
*'''$Sound:''' (Does not work with 'initial' animations)
**Defines sounds that are played with the animation
**'''+Start:'''
***Defines the sound that is played when animation starts
***Syntax: ????
**'''+Loop:'''
***Defines the sound that is played when animation is going on
***Syntax: ????
**'''+End:'''
***Defines the sound that is played when animation stops
***Syntax: ????
**'''+Radius:'''
***Defines the distance from the submodel where the sound is audible
***Syntax: ''Value'', (meters)

==Animation Examples==
===Setting Turret Angle===
*Animation code can be used to set multipart turrets barrel angle at the beginning of the mission
*'''Animation Class''' = triggered
**The only one available
*'''Animation Type''' = initial
**As we want the barrels to align themselves at the beginning of the mission
*'''Animation Code'''
**'''+relative_angle:''' is good for this purpose
**Notes about angles:
***First value is used to determine the turret's barrels deviation from the turrets normal. So barrel elevation in degrees is ( 90 - the first value ).
***Second value is used to determine the turret facing. With ''0'' the turret facing is in the normal setting and with ''180'' turn the turret completely around. Do note that turrets on the underside of the model normally face backwards so to get these turrets pointing to forward directin the second value has to be set to 180.

====Example====
$Subsystem: turret02,0.833,1.0
$Default PBanks: ( "Terran Turret" )
$animation: triggered
$type: initial
+relative_angle: 90,180,0

[[Category:Tables]]

Feature Requests

2006-01-01T06:18:42Z

Nuke:

This page is primarily to serve as a database for feature requests for the Source Code Project.

== New Requests ==

=== Toggleable subsystems ===
Support for subsystems that can be turned on and off (ie when 'off', act as though they never existed - are untargetable, leave behind no damage LOD, do not take damage, cannot be collided with, etc.) This would be useful for ships where someone might want to remove or swap a subsystem (ie fighter cockpits could have Terran and Vasudan versions).
* '''Supported By:''' No mods or campaigns AFAIK

=== Side Multipart Turrets ===
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

=== Gatling Turrets ===
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

=== Submodel Animation Triggers & Upgrades ===
Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Incremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva, Twisted Infinities, Shadows of Lylat

=== 3D Muzzle Flashes ===
Support for pof based 3d muzzel flashes. perhaps also add variables for scale factor and fade speed.
* '''Supported By:''' Nukemod - Children of Shiva

=== Arrays and Other Collections ===
Support for FRED using arrays or other collections (or both) in a similar fashion to variables as there is currently no way to directly associate two variables with each other. Obviously some way to search the collection for a certain value would be needed.
* '''Supported By:''' MindGames, The Babylon Project

== In Progress ==
=== Customizable ship types ===
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project

== Implemented ==
=== Flak Screen ===
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' The Apocalypse Project

Feature Requests

2006-01-01T06:18:02Z

Nuke:

Feature Requests

2005-12-15T01:02:40Z

Nuke: /* Submodel Animation Triggers & Upgrades */

This page is primarily to serve as a database for feature requests for the Source Code Project.

== Side Multipart Turrets ==
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

== Customizable ship types ==
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project

== Flak Screen ==
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' ???

== Gatling Turrets ==
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

== Submodel Animation Triggers & Upgrades ==

Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Incremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva

Feature Requests

2005-12-15T01:01:55Z

Nuke: /* Submodel Animation Triggers & Upgrades */

This page is primarily to serve as a database for feature requests for the Source Code Project.

== Side Multipart Turrets ==
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

== Customizable ship types ==
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project

== Flak Screen ==
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' ???

== Gatling Turrets ==
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

== Submodel Animation Triggers & Upgrades ==

Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Ingremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva

Feature Requests

2005-12-15T00:51:18Z

Nuke:

This page is primarily to serve as a database for feature requests for the Source Code Project.

== Side Multipart Turrets ==
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

== Customizable ship types ==
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project

== Flak Screen ==
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' ???

== Gatling Turrets ==
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

== Submodel Animation Triggers & Upgrades ==
Trigger Requests:
Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace and acts as a initial position if the "mission takes place in subspace" flag is set.
Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
Sexp - animation triggered by sexp.
Flight Control - triggered by the the activation, toggle or motion of a particular flight control.
Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again
Upgrades:
Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists
ingremental movement - moves a submodel to the position indicated, but does not undo the motion
glowpoint linking - make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s)
counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect
increase heirarchy depth instance limit to at least 10
simple linked animation support - support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva

Various Terms

2005-12-10T00:32:33Z

Nuke: /* Abbreviations of campaign names */

=Terms used by the Freespace community= 

==Terms related to abbreviations==
*V: This is equal with Volition, the creator of both Freespace games. On most occassions, the V is encircled by square brackets or ordinary brackets.
*SEXP: Do not think it has anything to do with copulation, it is the abbreviation for S-Expression, a term used by Mission Editors.
*FRED: FReeepace EDitor. The program we make missions with.
*FREDder: Mission designer/maker. Somebody who uses FRED.
*Mapper: Newcomers who have had any preliminary experience in level designing/creating for action games may think this term is the same as FREDer. Mappers are the same who most people would call texturers. In a word, the terms Mapper and Texturer mean exactly the same.
*SCP: The Source Code Project. 
**See [[Freespace Source Code Project]] for a lot of details
*HLP: [http://www.3dap.com/hlp Hard Light Productions]. The best known and most important forum of the Freespace community
*NW: [http://nodewar.penguinbomb.com/forum NodeWars ], now also called Penguinbomb; a forum run by a community member called an0n
*SG: [http://www.sectorgame.com/f2s/ Sectorgame]
*WS: [http://www.warpstorm.com/ Warpstorm], another forum where a few people of this community post. Not directly FS related.
*VWBB: Volition Watch Bulletin Board (site removed)
*VBB: Volition Bulletin Board (site removed, once was the official forum at www.freespace2.com
*COB: COB is a file extension. which are models which can be converted into POF files and then into the game
*POF: FreeSpace ships MUST be in POF extension. POF files contain all the necessary information about the model/ship, including dockpoints, subsystems, squadron logo locations and paths.
*PCS: POF Converter Suite. 
**SEE ALSO:
[[PCS]]
*FS2: This can not only mean FreeSpace 2, it also stands for an extension that is used for FreeSpace Missions
*FSM: Extension for Conflict: FreeSpace Missions
*TS: [[Truespace]], a model creation programma that many people use and almost as many people hate.
*3DMAX: 3D Max is a model creation programme that is used by some people in the community
*GMax: GMax is just another model creation programme that a few people use.

==Terms related to modelling==
*Greeble: Small piece of detail which serve no other purpose only to make a ship look better.
*LOD: Level of Detail. The further you get away from a ship, the less detailed it will be rendered.
*TrueView: A plugin utility for [[TrueSpace]]. Ideal for building hierarchy, however, not a must.
*Single-part turret: A single-part turret, is, in a word, a turret without any barrels.
*Multi-part turret: A multi-part turret is, in a word, a turret with one, two or three barrels.
----

=Abbreviations of campaign names=
*The 158th: The 158th Banshee Squadron
*AAB: Ascension and Beyond (dead)
*AHTW: All Hands to War (not hosted at HLP)
*AotD: Angels of the Damned (not hosted at HLP)
*TAP: The Apocalypse Project
*TBP: The Bablyon Project
*BWO: Blackwater Operations
*CoW: Casualties of War
*DEM: Deus Ex Machina
*FA: FRED Academy (This is not a campaign)
*FSC or FSPort: Freespace Conversion or Freespace Port (they're the same project)
*FSU: Freespace Upgrade Project
*ITHOV: Into the Halls of Valhalla
*JAD: Just Another Day
*JtEP: The Journey to Epsilon Pegasi
*LM: The Lightning Marshal
*MT: Machina Terra
*MG: Mind Games
*NTV: Neo-Terra victorious
*PI: The Procyon Insurgency (postponed indefinitely)
*RR: Renegade Ressurgence
*SA: Scroll of Antankharzim
*ST:R: Silent Threat: Reborn (a Freespace Port campaign)
*SWC: Star Wars Conversion. Also SWTC
*TI: Twisted Infinities
*TS: Technological Superiority (discontinued)
*TVWP: Terran-Vasudan War Project
*WCS: Wing Commander Saga
*CoS: Nukemod - Children of Shiva (also refered to as Nukemod-CoS or just Nukemod)

For more campaigns, and for info about them, see [http://fs2.kissifrot.com/ Skippy's campaign list]

[[Category:Lists]]

Feature Requests

2005-12-10T00:18:54Z

Nuke: