FreeSpace Wiki - User contributions [en]

Keywords.tbl

2024-08-27T22:43:29Z

Naomimyselfandi:

{{SCP_table}}
{{Tables}}
Keywords.tbl is [[SCPUI]]'s extension of the [[Briefing Text|color tag]] system. It allows styling important words throughout the briefing UIs without having to use inline color tags (although they are supported, under a different syntax, for one-off words). Keywords can also be given tooltips.

Keyword matching is performed in briefings (including loop and red alert briefings), command briefings, debriefings, the fiction viewer, and campaign descriptions. It utilizes SCPUI's HTML support, so they must be put into [[Briefing_Text#Styling_text_in_SCPUI|HTML mode]]. Keyword matching is ''not'' performed inside preexisting HTML tags, allowing them to override keywords. <code>Iceni<$slashspan></code> will render as Iceni, even if "Iceni" is keyworded as red italics normally.

Keyword matching uses a system of prefixes and suffixes to provide flexibility. When a keyword is matched, if it follows one of its prefixes, is followed by one of its suffixes, or both, the prefix and/or suffix is treated as part of the keyword. Prefixes and suffixes can be ''separate'', meaning they're their own word (or words), or ''separate'', meaning that they're part of the word they attach to. An example of the former would be ship prefixes like GTD or SC. An example of the latter would be the English possessive marker "'s".

Prefixes and suffixes are usually defined per keyword, but may be defined globally as well.

Keywords.tbl can be extended with xxx-kwrd.tbm.

==Keywords.tbl==
*Defines colors and tooltips for the briefing UIs throughout the SCPUI interface system.
*Begins with #Default and ends with #End.
*Translation support will be added soon™.

==#Default==
*This section defines the basic keyword colors and tooltips.

===+Prefix:===
*Define a globally-available separated prefix (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

===+Immediate Prefix:===
*Define a globally-available immediate prefix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Suffix:===
*Define a globally-available separated suffix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Immediate Suffix:===
*Define a globally-available immediate suffix (see above).
*Can be listed multiple times
*In English, this is typically used for plurals (s, es) and possessives ('s).
*Syntax: '''''string'''''

===$Style===
*Begin defining a keyword, and define the CSS class(es) associated with it.
*The string here should be a CSS class from common.rcss, or multiple such classes separated with spaces.
*Syntax: '''''string'''''

====+Prefix:====
*Define a separated prefix for this keyword (see above).
*Can be listed multiple times.
*An example would be GTD for a keyword representing a list of destroyers.
*Syntax: '''''string'''''

====+Immediate Prefix:====
*Define an immediate prefix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Suffix:====
*Define a separated suffix for this keyword (see above).
*Can be listed multiple times.
*Common examples include listing Roman numerals for planets orbiting a star, or digits after a wing name.
*Syntax: '''''string'''''

====+Immediate Suffix:====
*Define an immediate suffix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Text:====
*The actual keyword to apply this style to.
*Can be listed multiple times.
*There's no actual requirement that this be a single word - e.g. "Beta Aquilae" is perfectly valid.
*Syntax: '''''string'''''

=====++Tooltip:=====
*A tooltip to add to this specific keyword. Will show up if the mouse is hovered over the keyword.
*This applies ''only'' to the previous +Text: entry.
*Syntax: '''''string'''''

===Example===
<pre>
#Default

; Possessive markers
+Immediate Suffix: '
+Immediate Suffix: 's

; Friendly wings, and specific ships within those wings, are blue.
$Style: blue
+Suffix: 1
+Suffix: 2
+Suffix: 3
+Suffix: 4
+Text: Alpha
+Text: Beta
+Text: Gamma
; Delta, Epsilon, etc. omitted for brevity

; Stars and planets are yellow.
$Style: yellow
+Suffix: I
+Suffix: II
+Suffix: III
+Suffix: IV
+Suffix: V
+Suffix: VI
+Suffix: VII
+Suffix: VIII
+Text: Antares
+Text: Beta Aquilae
+Text: Delta Serpentis

$Style: blue
+Text: RIO
++Tooltip: Radar Intercept Officer
+Text: SAR
++Tooltip: Search and Rescue
+Text: OrBat
++Tooltip: Order of Battle

$Style: blue
+Suffix: s
+Text: Terran
+Text: Vasudan

$Style: green italic
+Prefix: GTD
+Text: Amadeus
+Text: Bastion
+Text: Delacroix
+Text: Eisenhower
+Text: Galatea
+Text: Goliath
+Text: Intrepid
+Text: Krios
+Text: Legion
+Text: Malendroke
+Text: Minnow
+Text: Nereid
+Text: Soyakaze
+Text: Uhuru
+Text: Vienna
; "Intrepid", "Intrepid's", "GTD Intrepid", and "GTD Intrepid's" will all be green and italicized.

#end

</pre>
[[Category:Tables]]
[[Category:SCPUI]]

Briefing Text

2024-08-27T22:42:36Z

Naomimyselfandi:

These tags can be used to manipulate text messages in command and mission briefings, and the fiction viewer. As of r10846, they work in debriefings, too.

[[SCPUI]] has its own HTML-based syntax to styling text.

==Colors==

The hue of these colors can be changed with the [[Colors.tbl]] but the tags will remain the same. As of r10926, the tags can also be customized.

A note about color tags: The color tag will work on all font until a space is encountered. There needs to be a space after the tag, before the text to be colorized (although it's not actually required after r5840, it is recommended due to the way FSO wordwrapping works). There is a method to color spans of text, which is discussed in the Misc section below.

Example: '$b This is $b blue $b text' will show as 'This is blue text'

*'''Bright White: $W'''
*'''Standard (default) White: $w'''
*'''Black: $k (Black)'''
*'''Standard Blue: $b'''
*'''Bright Blue: $B'''
*'''Standard Green: $g'''
*'''Bright Green: $G'''
*'''Standard Yellow: $y'''
*'''Bright Yellow: $Y'''
*'''Gray: $e'''
*'''Silver: $E'''
*'''Violet Gray: $v'''
*'''Violet: $V'''
*'''Standard Red: $r'''
*'''Bright Red: $R'''
*'''Pink: $p'''
*'''Bright Pink: $P'''
*'''Orange: $o'''

==Misc==

*The breaking tag $| can be used to stop a color before a character.
**$g Standard Green = '''Standard Green'''.
**$g Stand$|ard Green = '''Standard Green'''.
***If the above causes wordwrapping oddness, you may want to write $g Stand$| ard Green (output is identical: '''Standard Green''').
*$quote will create double quotes.
**Goober is $quotesilly$quote = Goober is "silly".
*$semicolon will create a semicolon.
*$callsign places the pilot name in its place.
*$rank places the player's rank in its place.
*$f, $h, & $n will color the text with the default colors for Friendly, Hostile and Neutral respectively. The colors are defined in the [[iff_defs.tbl]].
*Most special characters such as the comma ',', question mark '?', and exclamation point '!' cannot be colored as of 3.6.14.
*To color spans of text use $c{ and $}.
**The $y{ quick $g{ brown fox $r jumps over $} the lazy $} dog. = '''The quick brown fox jumps over the lazy dog.'''
**This method will color special characters such as the comma ',', question mark '?', and exclamation point '!'
**This method requires FSO build 8786 or later.
**As of r10846, color spans work across linebreaks as well (either manually-added, or automatic from wordwrapping).

==Styling text in SCPUI==

[[SCPUI]] has its own HTML-based approach to styling text. It works everywhere that classic color tags do - briefings (including command, loop, and red alert briefings), debriefings, and the fiction viewer - but also the tech room, campaign descriptions, and nearly everywhere that long-form text is supported. For it to work, the text must be put in "HTML mode" by putting <code>!html</code> at the start, followed by a space.

Text in HTML mode may contain HTML markup. Text may be styled using <code></code> tags with appropriate classes drawn from common.rcss; inline styles are also supported. FSO and HTML both make use of double quotes and slashes; to minimize conflicts, using single quotes and writing slashes as <code>$slash</code> is recommended. A complete example might look something like this: <code>!html Pilot attend!<$slashspan> Today, we'll be escorting the GTC Examplar<$slashspan> as she raids Shivan<$slashspan> positions throughout Gamma Draconis<$slashspan>.</code>

It is, however, rarely necessary to perform simple styling like this manually: SCPUI's [[Keywords.tbl]] may be used to automate common styling rules.

[[Category:FRED Tips]]

Keywords.tbl

2024-08-27T22:28:04Z

Naomimyselfandi:

{{SCP_table}}
{{Tables}}
Keywords.tbl is [[SCPUI]]'s extension of the [[Briefing Text|color tag]] system. It allows styling important words throughout the briefing UIs without having to use inline color tags (although they are supported, under a different syntax, for one-off words). Keywords can also be given tooltips.

Keyword matching is performed in briefings (including loop and red alert briefings), command briefings, debriefings, the fiction viewer, and campaign descriptions. It utilizes SCPUI's HTML support, so they must be put into HTML mode. Keyword matching is ''not'' performed inside preexisting HTML tags, allowing them to override keywords. <code>Iceni<$slashspan></code> will render as Iceni, even if "Iceni" is keyworded as red italics normally.

Keyword matching uses a system of prefixes and suffixes to provide flexibility. When a keyword is matched, if it follows one of its prefixes, is followed by one of its suffixes, or both, the prefix and/or suffix is treated as part of the keyword. Prefixes and suffixes can be ''separate'', meaning they're their own word (or words), or ''separate'', meaning that they're part of the word they attach to. An example of the former would be ship prefixes like GTD or SC. An example of the latter would be the English possessive marker "'s".

Prefixes and suffixes are usually defined per keyword, but may be defined globally as well.

Keywords.tbl can be extended with xxx-kwrd.tbm.

==Keywords.tbl==
*Defines colors and tooltips for the briefing UIs throughout the SCPUI interface system.
*Begins with #Default and ends with #End.
*Translation support will be added soon™.

==#Default==
*This section defines the basic keyword colors and tooltips.

===+Prefix:===
*Define a globally-available separated prefix (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

===+Immediate Prefix:===
*Define a globally-available immediate prefix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Suffix:===
*Define a globally-available separated suffix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Immediate Suffix:===
*Define a globally-available immediate suffix (see above).
*Can be listed multiple times
*In English, this is typically used for plurals (s, es) and possessives ('s).
*Syntax: '''''string'''''

===$Style===
*Begin defining a keyword, and define the CSS class(es) associated with it.
*The string here should be a CSS class from common.rcss, or multiple such classes separated with spaces.
*Syntax: '''''string'''''

====+Prefix:====
*Define a separated prefix for this keyword (see above).
*Can be listed multiple times.
*An example would be GTD for a keyword representing a list of destroyers.
*Syntax: '''''string'''''

====+Immediate Prefix:====
*Define an immediate prefix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Suffix:====
*Define a separated suffix for this keyword (see above).
*Can be listed multiple times.
*Common examples include listing Roman numerals for planets orbiting a star, or digits after a wing name.
*Syntax: '''''string'''''

====+Immediate Suffix:====
*Define an immediate suffix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Text:====
*The actual keyword to apply this style to.
*Can be listed multiple times.
*There's no actual requirement that this be a single word - e.g. "Beta Aquilae" is perfectly valid.
*Syntax: '''''string'''''

=====++Tooltip:=====
*A tooltip to add to this specific keyword. Will show up if the mouse is hovered over the keyword.
*This applies ''only'' to the previous +Text: entry.
*Syntax: '''''string'''''

===Example===
<pre>
#Default

; Possessive markers
+Immediate Suffix: '
+Immediate Suffix: 's

; Friendly wings, and specific ships within those wings, are blue.
$Style: blue
+Suffix: 1
+Suffix: 2
+Suffix: 3
+Suffix: 4
+Text: Alpha
+Text: Beta
+Text: Gamma
; Delta, Epsilon, etc. omitted for brevity

; Stars and planets are yellow.
$Style: yellow
+Suffix: I
+Suffix: II
+Suffix: III
+Suffix: IV
+Suffix: V
+Suffix: VI
+Suffix: VII
+Suffix: VIII
+Text: Antares
+Text: Beta Aquilae
+Text: Delta Serpentis

$Style: blue
+Text: RIO
++Tooltip: Radar Intercept Officer
+Text: SAR
++Tooltip: Search and Rescue
+Text: OrBat
++Tooltip: Order of Battle

$Style: blue
+Suffix: s
+Text: Terran
+Text: Vasudan

$Style: green italic
+Prefix: GTD
+Text: Amadeus
+Text: Bastion
+Text: Delacroix
+Text: Eisenhower
+Text: Galatea
+Text: Goliath
+Text: Intrepid
+Text: Krios
+Text: Legion
+Text: Malendroke
+Text: Minnow
+Text: Nereid
+Text: Soyakaze
+Text: Uhuru
+Text: Vienna
; "Intrepid", "Intrepid's", "GTD Intrepid", and "GTD Intrepid's" will all be green and italicized.

#end

</pre>
[[Category:Tables]]
[[Category:SCPUI]]

Keywords.tbl

2024-08-27T21:38:00Z

Naomimyselfandi:

{{SCP_table}}
{{Tables}}
Keywords.tbl is [[SCPUI]]'s extension of the [[Briefing Text|color tag]] system. It allows styling important words throughout the briefing UIs without having to use inline color tags (although they are supported, under a different syntax, for one-off words). Keywords can also be given tooltips.

Keyword matching uses a system of prefixes and suffixes to provide flexibility. When a keyword is matched, if it follows one of its prefixes, is followed by one of its suffixes, or both, the prefix and/or suffix is treated as part of the keyword. Prefixes and suffixes can be ''separate'', meaning they're their own word (or words), or ''separate'', meaning that they're part of the word they attach to. An example of the former would be ship prefixes like GTD or SC. An example of the latter would be the English possessive marker "'s".

Prefixes and suffixes are usually defined per keyword, but may be defined globally as well.

'''This feature only works in Briefing, Command Briefing, Debriefing, Fiction Viewer, Loop Briefing, and Red Alert, and only in HTML mode.'''

Keywords.tbl can be extended with xxx-kwrd.tbm.

==Keywords.tbl==
*Defines colors and tooltips for the briefing UIs throughout the SCPUI interface system.
*Begins with #Default and ends with #End.
*Translation support will be added soon™.

==#Default==
*This section defines the basic keyword colors and tooltips.

===+Prefix:===
*Define a globally-available separated prefix (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

===+Immediate Prefix:===
*Define a globally-available immediate prefix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Suffix:===
*Define a globally-available separated suffix (see above).
*Can be listed multiple times
*Syntax: '''''string'''''

===+Immediate Suffix:===
*Define a globally-available immediate suffix (see above).
*Can be listed multiple times
*In English, this is typically used for plurals (s, es) and possessives ('s).
*Syntax: '''''string'''''

===$Style===
*Begin defining a keyword, and define the CSS class(es) associated with it.
*The string here should be a CSS class from common.rcss, or multiple such classes separated with spaces.
*Syntax: '''''string'''''

====+Prefix:====
*Define a separated prefix for this keyword (see above).
*Can be listed multiple times.
*An example would be GTD for a keyword representing a list of destroyers.
*Syntax: '''''string'''''

====+Immediate Prefix:====
*Define an immediate prefix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Suffix:====
*Define a separated suffix for this keyword (see above).
*Can be listed multiple times.
*Common examples include listing Roman numerals for planets orbiting a star, or digits after a wing name.
*Syntax: '''''string'''''

====+Immediate Suffix:====
*Define an immediate suffix for this keyword (see above).
*Can be listed multiple times.
*Syntax: '''''string'''''

====+Text:====
*The actual keyword to apply this style to.
*Can be listed multiple times.
*There's no actual requirement that this be a single word - e.g. "Beta Aquilae" is perfectly valid.
*Syntax: '''''string'''''

=====++Tooltip:=====
*A tooltip to add to this specific keyword. Will show up if the mouse is hovered over the keyword.
*This applies ''only'' to the previous +Text: entry.
*Syntax: '''''string'''''

===Example===
<pre>
#Default

+Immediate Suffix: '
+Immediate Suffix: 's

; Friendly wings, and specific ships within those wings, are blue.
$Style: blue
+Suffix: 1
+Suffix: 2
+Suffix: 3
+Suffix: 4
+Text: Alpha
+Text: Beta
+Text: Gamma
; Delta, Epsilon, etc. omitted for brevity

; Stars and planets are yellow.
$Style: yellow
+Suffix: I
+Suffix: II
+Suffix: III
+Suffix: IV
+Suffix: V
+Suffix: VI
+Suffix: VII
+Suffix: VIII
+Text: Antares
+Text: Beta Aquilae
+Text: Delta Serpentis

$Style: blue
+Text: RIO
++Tooltip: Radar Intercept Officer
+Text: SAR
++Tooltip: Search and Rescue
+Text: OrBat
++Tooltip: Order of Battle

$Style: blue
+Suffix: s
+Text: Terran
+Text: Vasudan

$Style: green italic
+Prefix: GTD
+Text: Amadeus
+Text: Bastion
+Text: Delacroix
+Text: Eisenhower
+Text: Galatea
+Text: Goliath
+Text: Intrepid
+Text: Krios
+Text: Legion
+Text: Malendroke
+Text: Minnow
+Text: Nereid
+Text: Soyakaze
+Text: Uhuru
+Text: Vienna
; "Intrepid", "Intrepid's", "GTD Intrepid", and "GTD Intrepid's" will all be green and italicized.

#end

</pre>
[[Category:Tables]]
[[Category:SCPUI]]

Messages.tbl

2024-07-07T16:14:05Z

Naomimyselfandi: /* +Minimum Delay: */

{{TableVersion|10943}}
{{Tables}}
The '''messages.tbl''' is used to link actions, animations, and sounds of the messages received during the mission. Personas are used to group messages by the same talker, for example, all the Wingman 1 (Male Terran Pilot) messages go with a Wingman 1 persona.

Each message is composed of a text macro, and optionally a head .ani and/or an audio macro.

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

==#Message Settings==
{{Table232|
Optional settings for messages behavior}} 

===$Allow Any Ship To Send Backup Messages:===
{{Table232|
*By default, Backup messages won't play unless they have at least one filter. Enabling this option will enable backup messages globally
*Syntax: '''''boolean'''''}}

==#Message Frequencies==
{{Table3615|
Optional Group. Defines how often and how many times during the campaign the messages should be shown.}} 

===$Name:===
{{Table3615|
Required. Defines the message to augment.
*Syntax: '''String'''
*Available Values: See [[Messages.tbl#.24Name:_2|$Name in Messages.tbl]]}} 

===+Occurrence Chance:===
{{Table3615|
Optional. Defines the % chance this message will be played when the associated event occurs. For example, if you score a kill, and the '''+Occurrence Chance:''' is 10 for a Praise message, then there is a 10% chance that you a Praise message will play.
*Syntax: '''Integer'''
*Available Values: '''Between 0 and 100'''}} 

===+Maximum Count:===
{{Table3615|
Optional. Defines the maximum number of times this message will be played during a given mission.
*Syntax: '''Integer'''}} 

===+Minimum Delay:===
{{Table3615|
Optional. Defines a minimum delay time between instances of this message being sent. This applies globally across all message sources. ''Only supported for certain message types:'' Check 6, Help, Praise (which applies to High Praise as well), Praise Self, and Death. As of FSO 24.2, also supported for Arrive Enemy and Backup (which applies to the legacy Beta/Gamma/Delta/Epsilon Arrived messages as well).
}} 

==#Moods==
{{Table3615|
Optional. You can change the mission mood using the new set-mission-mood SEXP, and those moods can be used to filter what built-in messages are played by defining a mood within a message. This section lists all available moods for use in the table and in the SEXP.}} 

===$Mood:===
{{Table3615|
Optional. The name of a mood to be attached to a message and set as a mission mood. Example: Happy, Vengeful, etc.
*Syntax: '''String'''}} 

==#End==
{{Table3615|
The moods section, if it exists, must end with #End.}}

==#Personas==
Required. The #Personas group is used to define the all of the personas used for the messages. 

===$Persona:===
Required. Defines the name of the persona
*Syntax: '''String''' 

===$Type:===
Required. Defines the type of the persona
*Syntax: '''String'''
*Available types:
::'''wingman'''
::'''support'''
::'''large'''
::'''command''' 

===+<Species>===
Optional. The +<Species> (such as '''+Vasudan''') can be used to assign personas to other species. If omitted, the Persona is assigned to the '''default''' species.
*Syntax: +'''String''' 
{{Table232|This line can now appear multiple times, allowing a persona to be used by multiple species.}}

===$Allow substitution of missing messages:===
{{Table373|Optional. This is set to true by default, meaning that in cases where a Persona does not have defined messages for all built-in message types, the engine will try to find a matching message from other personas of the same type and species.
*Syntax: '''Boolean''' }}

===$No automatic assignment:===
{{Table232|Optional. This excludes a persona from being assigned to a ship that needs to send a message but does not have a specific persona assigned.
*Syntax: '''Boolean''' }}

==#Messages==
Required. The #Messages group contains all available messages. 

===$Name:===
Required. Defines the type of the message
*Syntax: '''String'''
*Available types (types marked with '''*''' do not have code support) :
**'''All Alone'''
**'''All Clear''' *
**'''Arrive Enemy'''
**'''Attack Target'''
**'''AWACS at 25'''
**'''AWACS at 75'''
**'''Backup'''
**'''Check 6'''
**'''Death'''
**'''Depart'''
**'''Disable Target'''
**'''Disarm Target'''
**'''Docking Start''' *
**'''Engage'''
**'''Help'''
**'''Ignore Target'''
**'''Instructor Attack'''
**'''Instructor Hit'''
**'''No Target'''
**'''No'''
**'''On way'''
**'''Oops 1''' * (Only Command has code support in Retail)
**'''Permission''' *
**'''Player Dead'''
**'''Praise'''
**'''Rearm on Way'''
**'''Rearm warping in'''
**'''Rearm'''
**'''Repair Aborted'''
**'''Repair Done'''
**'''Repair'''
**'''Stray Warning Final'''
**'''Stray Warning'''
**'''Stray''' *
**'''Support Killed'''
**'''Traitor'''
**'''yes'''
{{Table3611|
**'''High Praise'''
**'''Praise Self'''
**'''Primaries Low'''}}
{{Table232|
**'''Attack Subsystem'''
**'''Cover me'''
**'''Form on my wing'''
**'''Protect Target'''}} 
{{Table232|
**The following have been deprecated. Use '''Backup''' with a '''+Wing Name:''' [[Messages.tbl#Filters|Filter]] instead.
***'''Beta Arrived'''
***'''Gamma Arrived'''
***'''Delta Arrived'''
***'''Epsilon Arrived'''}}

===$Message: and $MessageNew:===
Defines the message shown in game screen when the message is triggered. Value is a reference to [[tstrings.tbl]]. 
'''$Message:''' is used for single-line messages, while '''$MessageNew:''' is used for multi-line messages (but can also be used for single-line messages)
*'''$MessageNew:''' is preferred over '''$Message:'''
*Syntax: XSTR("'''string'''", '''integer''') 

===+Persona:===
Optional. Defines the persona associated with the message
*Syntax:
'''String''' 

===+AVI Name:===
Optional. Determines the ANI file to be played when the message is triggered.

In FSO 3.7.4 and later, the game initially attempts to use the file ''<string>''.ani with a persona message. In earlier versions, or if ''<string>''.ani does not exist, the game picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', and ''Head-Joe.ani'' does not exist, the game will attempt to use the files ''Head-Joea.ani'', ''Head-Joeb.ani'' and ''Head-Joec.ani''. For wingmen personas, the ''c'' variant is assumed to be a death animation.
*Syntax: '''String''' 

===+Wave Name:===
Optional. Sets the sounds file that is played when the message is triggered
*Syntax: '''String''' 

===$Mood:===
{{Table3615|
The mood where this message should ideally be played. It may be played on other moods as long as it is not excluded for them below, if no better matching message is found.
*Syntax: '''String'''}} 

===$Exclude Mood:===
{{Table3615|
A list of moods not to play this message, ever. The list goes in parentheses. See Terran 'Attack Target' example below for usage.
*Syntax: '''String List'''}} 

===$Filter by sender:===
{{Table232|
*Control when this message can be sent based on the ship sending it. For example, you may want to give a pilot different lines based on whether they're flying a fighter or bomber.
*This may be followed by any number of filters. All filters must match for a message to be sent. A message with at least one filter is preferred to a message with no filters.
*Behind the scenes, "Beta Arrived", "Gamma Arrived", "Delta Arrived", and "Epsilon Arrived" messages are converted to Backup messages with a sender filter. This can be done manually to let other wings announce themselves; for example, <code>$Filter by sender: +Wing: Zeta</code> sets up a "Zeta Arrived" message.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by subject:===
{{Table232|
*Control when this message can be sent based on the ship the message is "about". For order confirmations, the subject is the target of the order. For Praise/High Praise/Praise Self messages, it's the ship that died. For Help and Check 6, it's the attacker. For arrival messages, it's the wing leader of the arriving wing.
*For example, you might want to provide a special message when enemy bombers arrive, or a special confirmation when attacking a warship.
*This may be followed by any number of filters. All filters must match for a message to be sent. A message with at least one filter is preferred to a message with no filters.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by other ship:===
{{Table232|
*Control when this message can be sent based on some other ship in the mission.
*This may be followed by any number of filters. At least one ship in the mission must match these filters, as well as the range checks below, if specified. A message with at least one filter is preferred to a message with no filters.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===+Within range of sender:===
{{Table232|
*Require that the 'other ship' must be within a certain range of the ship sending the message.
*Syntax: '''Integer'''}}

===$Prefer this message very highly===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message very highly</code> set.}}

===$Prefer this message highly===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message highly</code> or <code>$Prefer this message very highly</code> set.}}

===$Prefer this message===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message</code>, <code>$Prefer this message highly</code> or <code>$Prefer this message very highly</code> set.}}

==#End==
{{Table3615|
The very last entry must be #End. No exceptions.}} 

==#Simulated Speech Overrides==
{{Table3613|
Optional. Used to add file names to the generic message list, which defaults to 'none', 'cuevoice', 'cue_voice', 'emptymsg', 'generic', and 'msgstart'. Filenames listed below will be overridden by Text to Speech (TTS) when it is enabled, in addition to those in the default list.}} 

===$File Name:===
{{Table3613|
Optional. File name to add to the overrides list. Filenames provided here, however, must include an extension or a warning will be issues, for example msg_1.wav.
*Syntax: '''String'''}} 

==#End==
{{Table3613|
Must also end the optional Simulated Speech Overrides section with #End.}} 

==Filters==
{{Table232|
*Messages can be filtered with [[Messages.tbl#$Filter by sender:|$Filter by sender:]], [[Messages.tbl#$Filter by subject:|$Filter by subject:]], or [[Messages.tbl#$Filter by subject:|$Filter by other ship:]].
*These can be applied multiple times for each filer. So the following example would match Vasudan or Shivan Bombers and nothing else.
<pre>
+Species: Vasudan
+Species: Shivan
+Type: Bomber
</pre>}}

===+Ship name:===
*Matches the name of the ship
*Syntax: '''''String'''''

===+Callsign:===
*Matches the callsign of the ship
*Syntax: '''''String'''''

===+Class name:===
*Matches the class of the ship
*Respects alt-names as defined in FRED
*Syntax: '''''String'''''

===+Wing name:===
*Matches the wing that the ship is in
*Syntax: '''''String'''''

===+Species:===
*Matches the species of the ship
*Syntax: '''''String'''''

===+Type:===
*Matches the type of the ship as defined in [[objecttypes.tbl]]
*Syntax: '''''String'''''

===+Team:===
*Matches the ship's team as defined in [[Iff_defs.tbl]]
*Typically used with 'other ship' filters
*Syntax: '''''String'''''

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack_shivans_suck.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )
$Filter by subject:
+Species: Shivan

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack_love_killing_shivans.wav
$Mood: Happy
$Exclude Mood: ( "Angry" "Vengeful" )
$Filter by subject:
+Species: Shivan

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

$Name: Attack Target
$Message: XSTR("Affirmative. Bombing run commencing.", 2802)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack_bombing.wav
$Filter by sender:
+Type: Bomber
$Filter by subject:
+Type: Transport
+Type: Freighter
+Type: AWACS
+Type: Gas Miner
+Type: Cruiser
+Type: Corvette
+Type: Capital
+Type: Super Cap
+Type: Drydock

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

; These line won't be used unless $Allow Any Ship To Send Backup Messages: is turned on.

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

; This line will be used, since it has a filter.

$Name: Backup
$Message: XSTR("Omega wing on station. Request permission to kick ass.", 2803)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup_omega.wav
$Filter by sender:
+Wing: Omega

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

; Or equivalently...
; $Name: Delta Arrived
; $Message: XSTR("This is Delta wing. What's your status?", 2772)
; +Persona: Wingman 1
; +Avi Name: Head-TP1
; +Wave Name: 1_Delta.wav
; $Filter by sender:
; +Wing: Delta

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

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

Weapons.tbl

2024-06-25T02:17:16Z

Naomimyselfandi: Clarify FOF spread and reset rates

{{TableVersionGit|2023-10-25|bb47531c55b16bc9a965b446aecd431b6a7ef535}}
{{Tables}}
The '''weapons.tbl''' defines all of the weapon classes used in FSO.

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

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard 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]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in weapons.tbl or in earlier parsed *-wep.tbm files), the modular entry is skipped.}}

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

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

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

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

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

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center. Only valid if a tech model is defined
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

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

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

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

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

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

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}
{{Table38|
*Note: It's no longer required that the ship actually have external models enabled (whether or not this weapon has one defined) for the spin up delay to occur.
}}

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

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

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

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

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

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

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

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

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

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

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

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

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

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

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

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters
{{Table240|
===@Laser Length Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's length over time.
*The life of the weapon (0-1) is X, the length multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Head Radius:====
Defines the radius of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser head's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters

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

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

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

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

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

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

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

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

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

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

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

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

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

===$Mass:===
*Scales the kinetic effect this weapon has on its target. With higher mass imparting a stronger effect.
*The eventual kinetic effect is also multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. This is also true for the intesnity of the "shudder" effect, if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

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

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

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is approximately 5.88 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*The exact factor to multiply by is 100/17, or one 'pulse' of damage every 170 seconds. The generally used wisdom of 5.5 times may have been generally accurate before beam damage was made continuous and frame-rate independent, but is now out of date information.
*Syntax: '''''Float''''', damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)

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

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

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

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

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

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

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

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

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

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after traveling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

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

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defines if the bolts/missiles in question is homing

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how quickly the missile can turn. Ostensibly the number of seconds it takes the missile to do a 360 degree circle at full turn speed, but for complicated reasons this is only true if [[Game_settings.tbl#.2BAI_respect_tabled_turn_time_and_rotdamp|AI respect tabled turn time and rotdamp]] is enabled.
**Syntax: '''''Float''''', seconds

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

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option. They will continue to home on targets outside their view cone, but will take a continuous lifetime penalty every second their target is outside this cone.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

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

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

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

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

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

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

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

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

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

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

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

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

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

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

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Swarm will negatively affect the missile's ability to hit its target and will not lead its target even with [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] defined unless [[Game_settings.tbl#.24Swarmers_Lead_Targets:|$Swarmers Lead Targets]] is enabled.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150)}}

===$Acceleration Time:===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit:===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO parses but doesn't use the value, and prints a warning in the log. This feature has subsequently been reimplemented, see $Free Flight Speed Factor: below}}
}}

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

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

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

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

===$CockpitLaunchSnd:===
{{Table232|
*Corresponding sound effect when the weapon is launched from the player's ship, allowing use of 2d stereo sounds.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

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

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

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

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

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

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

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

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

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

===$InFlightSnd===
{{Table3615|
*The looping sound played while the player has this weapon currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

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

===$Rearm Rate:===
*Defines the frequency that weapons are loaded to the ship
*Syntax: '''''Float''''', How many times per second the weapons are loaded.
**Example: 2.0 will reload every half second. 0.1 will load every ten seconds.

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

===+Weapon Range:===
*If set, the AI will use this value or the result of weapon lifetime * velocity as the weapon's effective range, whichever is lower. This also affects the [[Hud_gauges.tbl#Lead_Indicator|Lead Indicator]]
*Syntax: '''''Float''''', meters

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

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

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

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

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

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

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
**Larger numbers above 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Smaller numbers below 1 cause it to fade away quickly at first, and then slow down for most of its life.
**Syntax: '''''Float''''', positive}}
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
{{Table202|
*'''+Spread:'''
**Causes the trail points to diffuse and drift apart at this speed over time.
**Syntax: '''''Float''''', meters per second}}
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table212|
*'''+Bitmap Stretch:'''
**Multiplies how far the bitmap is stretched over each trail segment.
**Syntax: '''''Float'''''}}
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

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

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

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

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

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

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

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

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the shield impact explosion, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Vampiric Healing Factor:===
{{Table224|
*Multiplier for how much the shooter is healed after dealing hull damage (1.0 means healing done is equal to damage dealt)
**Needs the [[#Vampiric|Vampiric]] flag set to have any effect
*Must be a positive number higher than 0.0
**Syntax: '''''Float''''' (defaults to 1.0)
}}

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

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

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

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missile's centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Like all spawn options, Spawn Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 180}}

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

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

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

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

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

===$Countermeasure:===

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

{{Table3610|
===='''+Heat Effectiveness:'''====
*Defines the countermeasures effectiveness against heat seeking missiles
*Syntax: '''''Float''''', cm effectiveness
**Default: 1.0

===='''+Aspect Effectiveness:'''====
*Defines the countermeasures effectiveness against aspect seeking missiles
*Syntax: '''''Float''''', cm effectiveness
*Default: 1.0

===='''+Effective Radius:'''====
*Defines the countermeasures effective radius
*Syntax: '''''Float''''', meters
**Default: 300.0
}}

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

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

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

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

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

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

}}

===$BeamInfo:===
*'''+Type:'''
*Defines the type of beam in question. This can be a number or, as of 21.4, a named type. Options are:
**''0'' or ''Direct fire'', a standard non-slashing type beam that fires directly at a random point on the target's hull
**''1'' or ''Slashing'', a slashing type beam, that slashes between opposing corners of the ship
**''2'' or ''Targeting'', a targeting beam that is used to trigger SSMs.
**''3'' or ''Antifighter'', a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles.
**''4'' or ''Normal Fire'', a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
{{Table214|
**''5'' or ''Omni'', a highly flexible kind of beam with many options for its exact behavior. See $Type 5 Beam Options below.}}
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
{{Table372|
*'''+Directional Glow:'''
**Defines the length to stretch the muzzleglow along the beam.
**Syntax: '''''Float''''', length in meters, the muzzleglow is rendered along (in the same plane) as the beam instead of perpendicular to the camera.}}
{{Table240|
*'''+Opacity over Lifetime Curve:'''
**Specifies the curve to use for changing the beam's opacity over time.
**The life of the beam while firing (0-1) is X, the opacity is Y, where 0 is invisible and 1 is typical opacity.
**Syntax: ''String'', the name of the curve from [[Curves.tbl]]}}
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**ALSO AFFECTS FIGHTER BEAMS. If greater than 0, fires from up to that many fire points at a time before cycling. 1 mimics the behavior of weapons with the "cycle" flag, 0 fires from all available fire points like normal weapons.
**Syntax: '''''Integer''''', Default: 1
*'''+ShrinkFactor:'''
**How much of the beam's life is remaining before it starts to shrink in width. (0.1 means 10% life left)
**Syntax: '''''Float''''', value from 0 to 1
*'''+ShrinkPct:'''
**The beam's width factor is reduced by this amount every second. For example, a value of 0.25 means the beam is at 75% width after 1 second, 50% after 2, 25% after 3, and by 4 seconds it reaches the minimum size of 10%.
**Syntax: '''''Float''''', a positive value
{{Table202|
*'''+GrowFactor:'''
**How much of the beam's life is remaining before it starts to grow in width. (1.0 means as soon as the beam fires)
**Syntax: '''''Float''''', value from 0 to 1
*'''+GrowPct:'''
**The beam's width factor is increased by this amount every second. For example, a value of 0.25 means a beam starting at 0% is at 25% width after 1 second, 50% after 2, 75% after 3, and by 4 seconds it reaches the maximum size of 100%.
**Syntax: '''''Float''''', a positive value
*'''+Initial Width Factor:'''
**What factor of the beam's maximum width it starts with.
**Syntax: '''''Float''''', value from 0 to 1}}
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
{{Table222|
*'''+Beam Light Flickers:'''
*Controls if the dynamic flickering of the beam width is applied to the light cast by the beam as well
*Syntax: '''''boolean'''''
*Default value: True
*'''+Beam Width Multiplies Light Radius:'''
*Controls if the light radius of a beam is multiplied by the beam width.
*Syntax: '''''boolean'''''
*Default value: True}}
{{Table38|
*'''+Beam Flash Particle Effect:'''
**Specifies the beam flash [[Particle Effects|particle effect]].
**Syntax: '''''String''''', particle effect name
**If this is specified then '''+Beam Flash Effect''' and '''+Beam Flash Radius''' are not valid options!
}}
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

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

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

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

*'''+Continuous Rotation:'''
**This defines the degrees per second that the beam will rotate while it is firing.
**Syntax: '''''Float''''', degrees per second
*'''+Continuous Rotation Axis:'''
**This defines the axis about which the beam will continuously rotate. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will rotate about the start position before the offset or randomness were applied. A beam which does not slash (end position paramters omitted), but is offset and rotates about this axis will trace out circles, for instance.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will rotate about the final start position after offset and randomness have been applied. If this beam slashes (end position paramters specified) it will trace out a spiral.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will rotate about the center of the target.

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

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only valid when editing beam sections that already exist in other tables. Attempting to index new sections will generate warnings, adding new sections is the default behavior for un-indexed sections.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be. (Zadd can be safely ignored; it actually does nothing.)
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**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 illuminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively
*'''Note''': TAG will not trigger unless the weapon in question has a non-zero damage value.

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

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

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

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

====+Max FOF:====
{{Table37|
*The maximum FOF. After the FOF reaches this value it will not increase any further.
*Syntax: ''''''Float'''''', degrees. Must be greater than or equal to zero.
*This is required if '''+FOF Spread Rate:''' is present}}

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

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

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

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

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
*If this weapon is cycling each individual firing event counts as one burst shot, so bursts end sooner in time for large banks than small.
**Syntax: '''''Integer'''''}}

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

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}

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

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

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

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

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

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

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

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

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''

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

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

}}

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

+Val: Name Value

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

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

==Weapons.tbl Flags==

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

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

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

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

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it, but only if the weapon is in a turret or is a secondary. If the weapon is a primary in a fighter then there are no targeting restrictions. See [[Weapons.tbl#.22capital.2B.22|capital+]] instead.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.) Only applies to the target selection of turrets, has no effect on the behavior of fighters picking primary and secondary bank weapons.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

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

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dynamic SEXPs

2024-05-06T21:15:18Z

Naomimyselfandi:

{{Tables}}
Since version 3.8.2 FSO supports adding custom SEXPs to a mod which have a user defined effect. Currently there is only one way to add such a SEXP but more may be added in the future.

Dynamic SEXPs are only added in modular table files which end with <tt>-sexp.tbm</tt>

==Table syntax==
This section will describe the syntax and effects of the individual options.

===#Lua Enums===

{{Table232|
Specifies lists of dynamic Enums that can be referenced in in Lua sexps This section must end with <tt>#End</tt>}}

====$Name:====
{{Table232|
*The name of this enum list. Must be unique.
*Syntax: '''''String'''''}}

====+Enum:====
{{Table232|
*The enum item itself.
*No limit to the number of enums listed
*Syntax: '''''String'''''}}

===#Lua SEXPs===

Specifies a list of dynamic SEXPs implemented using a Lua function (see [[#Lua interface|Lua interface]] for how to use the implementation function). This section must end with <tt>#End</tt>

====$Operator:====
*Adds a new SEXP operator with the specified name. The name may not contain the following characters: <tt>()\"'</tt>. Furthermore, any whitespace (tab characters or spaces) are also not permitted. This is the name under which this operator will appear in the SEXP code. While the name is mostly up to you it would be a good idea to keep it in line with how the other SEXPs are named. To avoid conflicts with other custom SEXPs you should also use a unique prefix. For example, if you want to have some SEXP operators that control a cloaking script then you could use <tt>cloak-</tt> as the common prefix for all the operators that are related to this system. A SEXP that disables the cloak system could be named something like <tt>cloak-disable</tt>.
*This name must be unique among all operators that are known to the SEXP system. That includes built-in SEXPs and operators added before. If there is a conflict then the new operator definition will be ignored. Built-in operators always take precedence.
*Syntax: '''''String'''''

====$Category:====
*Specifies in which category this SEXP will appear in the context menu in the FRED event editor. Only one of the existing categories may be used. These are all the currently defined categories:
**Objectives
**Time
**Logical
**Arithmetic
**Status
**Change
**Conditionals
**Ai goals
**Event/Goals
**Training
*Syntax: '''''String'''''

====$Subcategory:====
*Specifies into which subcategory this SEXP should be put. This is the second level in the context menu of the FRED event editor. New subcategories can be added by specifying a new name here but all subcategory names must be globally unique (you can't have the same subcategory name under two different categories).
*Syntax: '''''String'''''

====$Minimum Arguments:====
*Specifies what minimum number of parameters this SEXP needs to work. If fewer parameters are specified, then the SEXP parser will treat this as an error.
*Must be at least 0.
*Syntax: '''''Integer'''''

====$Maximum Arguments:====
*Specifies the maximum number of parameters this SEXP can process.
*Optional. If this option is not present then the SEXP can process an unlimited number of parameters.
*Must be at least 0 and greater or equal to $Minimum Arguments.

====$Return Type:====
*Specifies what data type this SEXP will return when invoked. Can be one of the following:
**; number: The SEXP will return an integer. The scripting function needs to return a number value.
**; boolean: The SEXP will return a boolean. The scripting function must return a boolean value.
**; nothing: The SEXP will return nothing. The scripting function may not return anything.
*Optional. Defaults to ''nothing''
*Syntax: '''''String'''''

====$Description:====
*Sets the help text displayed in the FRED help box. This should be the generic description of what this SEXP does but should not include the documentation for the individual parameters.
*Syntax: '''''String'''''

====$Repeat====
*This option must be combined with the parameter documentation below to specify a repeating pattern in a SEXP with a variable number of parameters. See the example below for how exactly this will work. All parameters specified after this option will be grouped together. The script will receive these groups of parameters as a single entity (see [[#Lua interface|Lua interface]]) to make it easier to use the values without having to separate them again in the script.

====$Parameter:====
*Adds documentation for the parameters and specifies what type they need to have. This option may appear multiple times and should match the number of parameters specified by <tt>$Minimum Arguments</tt> and <tt>$Maximum Arguments</tt>.
*This option has no value.

====+Description:====
*Sets the description of this parameter. This will be used for the documentation text.
*Syntax: '''''String'''''

====+Type:====
*Sets the type this parameter requires. The currently supported types are:
**; boolean: This parameter is a boolean. The SEXP system will evaluate the expression for this parameter (which may be another SEXP operator) and pass the result to the script.
**; number: This parameter is a number. The SEXP system will evaluate the expression for this parameter (which may be another SEXP operator) and pass the result to the script.
**; ship: This parameter is the name of a ship. The script will receive this value as a <tt>ship</tt> handle. If the name provided by the mission is invalid (if the ship has not arrived yet or if it is not present anymore) then the script will receive an invalid <tt>ship</tt> handle.
**; shipname: This parameter is the name of a ship. Unlike the '''ship''' parameter, the script will receive this value as a <tt>string</tt>. This provides a way to refer to ships which may not be present yet or which may have exited the mission.
**; string: This parameter is a generic string with no special format. In Unicode mode this string may contain Unicode characters.
**; team: This parameter is a handle to a specific team. The script will receive this value as a <tt>team</tt> handle.
**; waypointpath: This parameter is a reference to a specific waypoint path. The script will receive this as a <tt>waypointlist</tt> handle.
**; variable: This is a reference to a SEXP variable. This is a reference to the actual variable and not its contents. The script will receive this as a <tt>sexpvariable</tt> handle.
**; message: This is a reference to a mission message. The script will receive it as a <tt>message</tt> handle.
**; wing: This is a reference to a wing in the mission. The script will receive it as a <tt>wing</tt> handle.
**; shipclass: This is a reference to a table ship class. The script will receive it as a <tt>shipclass</tt> handle.
**; weaponclass: This is a reference to a table weapon class. The script will receive it as a <tt>weaponclass</tt> handle.
**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.
{{Table220|
**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will receive it as an <tt>oswpt</tt> handle.
}}
{{Table224|
**; enum: A pre-defined enumeration list. The script will receive it as a string.
}}
{{Table232|
**; hudgauge: This is a reference to any built-in or custom hud gauge. The script will receive it as a <tt>hudgauge</tt> handle.
**; event: This is a reference to existing mission events. The script will receive it as an <tt>event</tt> handle.
**; subsystem: This is a reference to a ship's subsystems and requires [[Dynamic_SEXPs#+Parent Parameter Index:|+Parent Parameter Index]]. The script will receive it as a <tt>subsystem</tt> handle.
**; dockpoint: This is a reference to a ship's docking points and requires [[Dynamic_SEXPs#+Parent Parameter Index:|+Parent Parameter Index]]. The script will receive it as a <tt>dockingbay</tt> handle.
}}
{{Table234|
**; waypoint: This is a reference to a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
**; child_enum: A pre-defined enumeration list, but gets the list name from [[Dynamic_SEXPs#+Parent Parameter Index:|+Parent Parameter Index]]. Can optionally use [[Dynamic_SEXPs#+Suffix:|+Suffix]]. The script will receive it as a string.
}}
*Syntax: '''''String'''''

====+Enum name:====
{{Table224|
*Required if the +Type is an enum.
*The name of the enum list.
{{Table232|
*Can reference a pre-parsed enum list.}}
*Syntax: '''''String'''''}}

====+Enum:====
{{Table224|
*An item to add to the enum list.
*As many +Enum: entries can be specified as needed.
{{Table232|
*If +Enum Name references a pre-parsed enum list and this field is used, then it will add to that list just for this specific sexp.}}
*Syntax: '''''String'''''}}

====+Parent Parameter Index:====
{{Table232|
*The zero-based index to the parent parameter that should be used for types that require it.
*If [[Dynamic_SEXPs#$Repeat|$Repeat]] is used then the last parsed index is the one that will be repeated.
*An index setting of -1 will always return the immediately previous sexp argument, even if [[Dynamic_SEXPs#$Repeat|$Repeat]] is active.
*Defaults to -1 if this is not provided for a type that requires it
*Syntax: '''''Integer'''''}}

====+Suffix:====
{{Table240|
*An arbitrary string to suffix to the enum parent's name.
*For example, if the parent enum is a ship type, you can add the suffix and the enum list that will be used will be SHIPNAME + suffix
*Syntax: '''''string'''''}}

{{Table222|
===#Lua AI===
Specifies new SEXPs that can be used as AI-goals in FRED, which execute custom Lua script.

====$Operator:====
*Adds a new SEXP operator with the specified name. The name may not contain the following characters: <tt>()\"'</tt>. Furthermore, any whitespace (tab characters or spaces) are also not permitted. This is the name under which this operator will appear in the SEXP code.
*This name must be unique among all operators that are known to the SEXP system. That includes built-in SEXPs and operators added before. If there is a conflict then the new operator definition will be ignored. Built-in operators always take precedence.
*Syntax: '''''String'''''

====$Description:====
*Sets the help text displayed in the FRED help box. This should be the generic description of what this AI Goal does.
*Syntax: '''''String'''''

====+HUD String:====
*If set, this string will be displayed when targeting a ship executing this AI goal, similar to "attacking" when given a chase goal.
*Optional.
*Syntax: '''''String'''''

====$Target Parameter:====
*If set, this AI mode will take a target as the first parameter of the AI goal SEXP.
*Optional.

=====+Description:=====
*The description of the target parameter
*Syntax: '''''String'''''

=====+Type:=====
*The type the target parameter requires. The script will receive all of the following parameter types as an <tt>oswpt</tt> handle. Only the following are permitted:
**; ship: This parameter is the name of a ship.
**; wing: This is a reference to a wing in the mission.
**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint.
**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present.
**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present.
**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present.
**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present.
**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none.
*Syntax: '''''String'''''

====$Player Order:====
*If set, this AI mode will be available as a player order (in the comms menu). As of now ''only 16 more'' player orders can be registered like this. Any player order registered like this also needs to be added as a valid player order in the [[Objecttypes.tbl]] table. Player orders must have either no target parameter at all, or a target parameter of the ship type.
*Optional.

=====+Display String:=====
*The name of the order shown to the player in the comms menu
*Syntax: '''''String'''''

=====+Parse String:=====
*The name of the order as it needs to be entered in the [[Objecttypes.tbl]].
*Optional. Equal to the display string by default.
*Syntax: '''''String'''''

=====+Target Restrictions:=====
*Requirements a ship must fulfill to be a valid target for this order. This may be fine-tuned by registering a `TargetRestrict` function.
**; All: Any ship is a valid target.
**; Allies: The target must be of a team that is not attacked by the player.
**; Own Team: The target must be of the same team as the player.
**; Hostiles: The target must be of a team that is attacked by the player.
**; Same Wing: The target and the ship receiving the order must be on the same wing.
**; Player Wing: The target and the player must be on the same wing.
**; Capitals: The ship must be a capital ship (i.e. any large ship, including a transport or freighter).
**; Allied Capitals: The ship must be an ally and a capital ship.
**; Enemy Capitals: The ship must be a hostile and a capital ship.
**; Not Self: The ship must not be the ship receiving the order.
*Optional. All by default.
*Syntax: '''''String'''''

{{Table232|
=====+Ship Restrictions:=====
*Requirements on what can receive this order.
**; Any: Any ship or wing can receive this order.
**; On Player Wing: Only a ship on the player's wing can receive this order.
**; Wing: This order may only be sent to wings, not individual ships.
**; Player Wing: This order may only be sent to the player's wing.
*Optional. All by default.
*Syntax: '''''String'''''
}}

=====+Acknowledge Message:=====
*Once the player gives the player order, this message will be played. Can be any of the messages listed [[Messages.tbl#.24Name:_2|here]].
*Optional, the "Yes Sir!"-message (<tt>yes</tt>) by default.
*Syntax: '''''String'''''

{{Table224|
====$Minimum Additional Arguments:====
*Specifies what minimum number of parameters this SEXP needs to work. If fewer parameters are specified, then the SEXP parser will treat this as an error.
*Optional. 0 by default. Must be at least 0.
*Syntax: '''''Integer'''''

====$Maximum Additional Arguments:====
*Specifies the maximum number of parameters this SEXP can process.
*Optional. If this option is not present then the SEXP can process an unlimited number of parameters.
*Must be at least 0 and greater or equal to $Minimum Arguments.

====$Repeat====
*This option must be combined with the additional parameter specification below to specify a repeating pattern in a SEXP with a variable number of parameters. See the example below for how exactly this will work. All parameters specified after this option will be grouped together. The script will receive these groups of parameters as a single entity (see [[#Lua interface|Lua interface]]) to make it easier to use the values without having to separate them again in the script.

====$Additional Parameter:====
*Adds additional parameters beyond the target and specifies what type they need to have. This option may appear multiple times and should match the number of parameters specified by <tt>$Minimum Additional Arguments</tt> and <tt>$Maximum Additional Arguments</tt>. When called from a player order, all Additional Parameters beyond the Target Parameter will be nil
*This option has no value.

====+Description:====
*Sets the description of this parameter. This will be used for the documentation text.
*Syntax: '''''String'''''

====+Type:====
*Sets the type this parameter requires. The currently supported types are:
**; boolean: This parameter is a boolean. The SEXP system will evaluate the expression for this parameter (which may be another SEXP operator) and pass the result to the script.
**; number: This parameter is a number. The SEXP system will evaluate the expression for this parameter (which may be another SEXP operator) and pass the result to the script.
**; ship: This parameter is the name of a ship. The script will receive this value as a <tt>ship</tt> handle. If the name provided by the mission is invalid (if the ship has not arrived yet or if it is not present anymore) then the script will receive an invalid <tt>ship</tt> handle.
**; shipname: This parameter is the name of a ship. Unlike the '''ship''' parameter, the script will receive this value as a <tt>string</tt>. This provides a way to refer to ships which may not be present yet or which may have exited the mission.
**; string: This parameter is a generic string with no special format. In Unicode mode this string may contain Unicode characters.
**; team: This parameter is a handle to a specific team. The script will receive this value as a <tt>team</tt> handle.
**; waypointpath: This parameter is a reference to a specific waypoint path. The script will receive this as a <tt>waypointlist</tt> handle.
**; variable: This is a reference to a SEXP variable. This is a reference to the actual variable and not its contents. The script will receive this as a <tt>sexpvariable</tt> handle.
**; message: This is a reference to a mission message. The script will receive it as a <tt>message</tt> handle.
**; wing: This is a reference to a wing in the mission. The script will receive it as a <tt>wing</tt> handle.
**; shipclass: This is a reference to a table ship class. The script will receive it as a <tt>shipclass</tt> handle.
**; weaponclass: This is a reference to a table weapon class. The script will receive it as a <tt>weaponclass</tt> handle.
**; soundentry: This is a reference to a table defined game sound. The script will receive it as a <tt>soundentry</tt> handle.
**; ship+waypoint: This can be a reference to either a ship, both present and not yet present, or a waypoint. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing: This can be a reference to either a ship or a wing, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+team: This can be a reference to either a ship, a wing or a whole team, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+ship_on_team+waypoint: This can be a reference to either a ship, a wing, any ship on a team, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+waypoint: This can be a reference to either a ship, a wing, or a waypoint, both present and not yet present. The script will receive it as an <tt>oswpt</tt> handle.
**; ship+wing+waypoint+none: This can be a reference to either a ship, a wing, a waypoint, both present and not yet present, or none. The script will receive it as an <tt>oswpt</tt> handle.
*Syntax: '''''String'''''
}}
}}

===Example===
<pre>
#Lua SEXPs

$Operator: dynamic-sexp
$Category: Change
$Subcategory: Scripted
$Minimum Arguments: 3
; No maximum arguments means that it accepts a variable number of arguments
$Return Type: Nothing
$Description: This is a dynamic parameter test SEXP
$Parameter:
+Description: Number parameter
+Type: Number
$Parameter:
+Description: Ship parameter
+Type: Ship
$Parameter:
+Description: Variable name parameter
+Type: variable
$Repeat ; This starts the part of the parameter list where the parameter pattern repeats
$Parameter:
+Description: Variable string parameter
+Type: string
$Parameter:
+Description: Variable number parameter
+Type: Number

#End
</pre>

==Lua interface==
===Lua SEXPs===
So far, all the SEXP table has done is specify that a new Lua SEXP exists but there is no actual action which will be executed when the SEXP is called. For the Lua language this can be done using the <tt>mn.LuaSEXPs</tt> variable. This is a variable which can be indexed using the SEXP name. The returned value is of type <tt>LuaSEXP</tt> which only has a single field, <tt>Action</tt>. This is the function that will be executed once the SEXP is called in a mission. You can use it to retrieve the function of a LuaSEXP but the more common use case is that it is written in the <tt>$On Game Init</tt> hook to set the action function.

The action function will receive the values as normal parameters. If the SEXP will receive a variable number of parameters then you can use <tt>...</tt> as the last parameter to also capture these values. If a parameter is optional and not specified by the SEXP invocation then it will be <tt>nil</tt> in the script. Parameters in the repeat pattern of the parameter list will be grouped into a array of arrays where each array instance contains the individual values. See below for an example of how this can be handled in the Lua code.

<pre>
#Conditional Hooks

$Application: FS2_Open
$On Game Init: [
mn.LuaSEXPs["dynamic-sexp"].Action = function (arg1, arg2, arg3, ...)
ba.print(tostring(arg1)
ba.print(arg2.Name)
ba.print(tostring(arg3.Value))

for val in {...} do
ba.print(val[1])
ba.print(tostring(val[2]))
done
end
]

#End
</pre>

===Lua AI===

LuaAI operators are more complicated than standard Lua operators. They are defined by two main functions and two optional functions.

The <code>ActionEnter</code> and <code>ActionFrame</code> functions define the operator's behavior. <code>ActionEnter</code> is called only once, when a ship receives the order; it may be used for any needed setup. <code>ActionFrame</code> is called once per frame. Both functions receive an <code>ai_helper</code> object, the target (if any), and any additional arguments; they should return <code>true</code> if the order is complete, and <code>false</code> otherwise.

The <code>Achievability</code> function defines whether the order is currently achievable. It accepts the ship executing the order, the target (if any), and any additional arguments. It may return <code>LUAAI_ACHIEVABLE</code> if the order can currently be achieved, <code>LUAAI_UNACHIEVABLE</code> if the order cannot be achieved and should be removed from the ship, and <code>LUAAI_NOT_YET_ACHIEVABLE</code> if the order cannot currently be achieved, but may become possible later; this allows an order which doesn't make sense right now to be suspended until later.

Lastly, the <code>TargetRestrict</code> function may be used to fine-tune the order's targeting. It accepts a ship and a nilable OSWPT handle representing the target, and returns whether or not the target is valid. This is checked only if the target already satisfies the `+Target Restrictions:`.

Example:

<pre>
#Conditional Hooks

$Application: FS2_Open
$On Game Init: [
mn.LuaAISEXPs["ai-ram"].ActionEnter = function(ai_helper, target)
--Print info to the log
ba.print("Targeting " .. target:get().Name .. " from " .. ai_helper.Ship.Name .. "!")
return false
end

mn.LuaAISEXPs["ai-ram"].ActionFrame = function(ai_helper, target)
--Turn towards and fly into the target
helper:turnTowardsPoint(target:get().Position)
helper.ForwardThrust = 1
return false
end

mn.LuaAISEXPs["ai-ram"].Achievability = function(ship, target)
if ship.Disabled then
-- Contrived example
return LUAAI_NOT_YET_ACHIEVABLE
elseif target:isValid() then
return LUAAI_ACHIEVABLE
else
return LUAAI_UNACHIEVABLE
end
end
]

#End
</pre>

[[Category:Tables]]
[[Category:Source Code Project]]

Messages.tbl

2024-04-28T20:12:34Z

Naomimyselfandi:

{{TableVersion|10943}}
{{Tables}}
The '''messages.tbl''' is used to link actions, animations, and sounds of the messages received during the mission. Personas are used to group messages by the same talker, for example, all the Wingman 1 (Male Terran Pilot) messages go with a Wingman 1 persona.

Each message is composed of a text macro, and optionally a head .ani and/or an audio macro.

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

==#Message Settings==
{{Table232|
Optional settings for messages behavior}} 

===$Allow Any Ship To Send Backup Messages:===
{{Table232|
*By default, Backup messages won't play unless they have at least one filter. Enabling this option will enable backup messages globally
*Syntax: '''''boolean'''''}}

==#Message Frequencies==
{{Table3615|
Optional Group. Defines how often and how many times during the campaign the messages should be shown.}} 

===$Name:===
{{Table3615|
Required. Defines the message to augment.
*Syntax: '''String'''
*Available Values: See [[Messages.tbl#.24Name:_2|$Name in Messages.tbl]]}} 

===+Occurrence Chance:===
{{Table3615|
Optional. Defines the % chance this message will be played when the associated event occurs. For example, if you score a kill, and the '''+Occurrence Chance:''' is 10 for a Praise message, then there is a 10% chance that you a Praise message will play.
*Syntax: '''Integer'''
*Available Values: '''Between 0 and 100'''}} 

===+Maximum Count:===
{{Table3615|
Optional. Defines the maximum number of times this message will be played during a given mission.
*Syntax: '''Integer'''}} 

===+Minimum Delay:===
{{Table3615|
Optional. Defines the minimum delay time between being queue by the game and the time the message actually plays. (This helps simulate "organic" AI's)
*Syntax: '''Integer''' in milliseconds}} 

==#Moods==
{{Table3615|
Optional. You can change the mission mood using the new set-mission-mood SEXP, and those moods can be used to filter what built-in messages are played by defining a mood within a message. This section lists all available moods for use in the table and in the SEXP.}} 

===$Mood:===
{{Table3615|
Optional. The name of a mood to be attached to a message and set as a mission mood. Example: Happy, Vengeful, etc.
*Syntax: '''String'''}} 

==#End==
{{Table3615|
The moods section, if it exists, must end with #End.}}

==#Personas==
Required. The #Personas group is used to define the all of the personas used for the messages. 

===$Persona:===
Required. Defines the name of the persona
*Syntax: '''String''' 

===$Type:===
Required. Defines the type of the persona
*Syntax: '''String'''
*Available types:
::'''wingman'''
::'''support'''
::'''large'''
::'''command''' 

===+<Species>===
Optional. The +<Species> (such as '''+Vasudan''') can be used to assign personas to other species. If omitted, the Persona is assigned to the '''default''' species.
*Syntax: +'''String''' 
{{Table232|This line can now appear multiple times, allowing a persona to be used by multiple species.}}

===$Allow substitution of missing messages:===
{{Table373|Optional. This is set to true by default, meaning that in cases where a Persona does not have defined messages for all built-in message types, the engine will try to find a matching message from other personas of the same type and species.
*Syntax: '''Boolean''' }}

===$No automatic assignment:===
{{Table232|Optional. This excludes a persona from being assigned to a ship that needs to send a message but does not have a specific persona assigned.
*Syntax: '''Boolean''' }}

==#Messages==
Required. The #Messages group contains all available messages. 

===$Name:===
Required. Defines the type of the message
*Syntax: '''String'''
*Available types (types marked with '''*''' do not have code support) :
**'''All Alone'''
**'''All Clear''' *
**'''Arrive Enemy'''
**'''Attack Target'''
**'''AWACS at 25'''
**'''AWACS at 75'''
**'''Backup'''
**'''Check 6'''
**'''Death'''
**'''Depart'''
**'''Disable Target'''
**'''Disarm Target'''
**'''Docking Start''' *
**'''Engage'''
**'''Help'''
**'''Ignore Target'''
**'''Instructor Attack'''
**'''Instructor Hit'''
**'''No Target'''
**'''No'''
**'''On way'''
**'''Oops 1''' * (Only Command has code support in Retail)
**'''Permission''' *
**'''Player Dead'''
**'''Praise'''
**'''Rearm on Way'''
**'''Rearm warping in'''
**'''Rearm'''
**'''Repair Aborted'''
**'''Repair Done'''
**'''Repair'''
**'''Stray Warning Final'''
**'''Stray Warning'''
**'''Stray''' *
**'''Support Killed'''
**'''Traitor'''
**'''yes'''
{{Table3611|
**'''High Praise'''
**'''Praise Self'''
**'''Primaries Low'''}}
{{Table232|
**'''Attack Subsystem'''
**'''Cover me'''
**'''Form on my wing'''
**'''Protect Target'''}} 
{{Table232|
**The following have been deprecated. Use '''Backup''' with a '''+Wing Name:''' [[Messages.tbl#Filters|Filter]] instead.
***'''Beta Arrived'''
***'''Gamma Arrived'''
***'''Delta Arrived'''
***'''Epsilon Arrived'''}}

===$Message: and $MessageNew:===
Defines the message shown in game screen when the message is triggered. Value is a reference to [[tstrings.tbl]]. 
'''$Message:''' is used for single-line messages, while '''$MessageNew:''' is used for multi-line messages (but can also be used for single-line messages)
*'''$MessageNew:''' is preferred over '''$Message:'''
*Syntax: XSTR("'''string'''", '''integer''') 

===+Persona:===
Optional. Defines the persona associated with the message
*Syntax:
'''String''' 

===+AVI Name:===
Optional. Determines the ANI file to be played when the message is triggered.

In FSO 3.7.4 and later, the game initially attempts to use the file ''<string>''.ani with a persona message. In earlier versions, or if ''<string>''.ani does not exist, the game picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', and ''Head-Joe.ani'' does not exist, the game will attempt to use the files ''Head-Joea.ani'', ''Head-Joeb.ani'' and ''Head-Joec.ani''. For wingmen personas, the ''c'' variant is assumed to be a death animation.
*Syntax: '''String''' 

===+Wave Name:===
Optional. Sets the sounds file that is played when the message is triggered
*Syntax: '''String''' 

===$Mood:===
{{Table3615|
The mood where this message should ideally be played. It may be played on other moods as long as it is not excluded for them below, if no better matching message is found.
*Syntax: '''String'''}} 

===$Exclude Mood:===
{{Table3615|
A list of moods not to play this message, ever. The list goes in parentheses. See Terran 'Attack Target' example below for usage.
*Syntax: '''String List'''}} 

===$Filter by sender:===
{{Table232|
*Control when this message can be sent based on the ship sending it. For example, you may want to give a pilot different lines based on whether they're flying a fighter or bomber.
*This may be followed by any number of filters. All filters must match for a message to be sent. A message with at least one filter is preferred to a message with no filters.
*Behind the scenes, "Beta Arrived", "Gamma Arrived", "Delta Arrived", and "Epsilon Arrived" messages are converted to Backup messages with a sender filter. This can be done manually to let other wings announce themselves; for example, <code>$Filter by sender: +Wing: Zeta</code> sets up a "Zeta Arrived" message.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by subject:===
{{Table232|
*Control when this message can be sent based on the ship the message is "about". For order confirmations, the subject is the target of the order. For Praise/High Praise/Praise Self messages, it's the ship that died. For Help and Check 6, it's the attacker. For arrival messages, it's the wing leader of the arriving wing.
*For example, you might want to provide a special message when enemy bombers arrive, or a special confirmation when attacking a warship.
*This may be followed by any number of filters. All filters must match for a message to be sent. A message with at least one filter is preferred to a message with no filters.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by other ship:===
{{Table232|
*Control when this message can be sent based on some other ship in the mission.
*This may be followed by any number of filters. At least one ship in the mission must match these filters, as well as the range checks below, if specified. A message with at least one filter is preferred to a message with no filters.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===+Within range of sender:===
{{Table232|
*Require that the 'other ship' must be within a certain range of the ship sending the message.
*Syntax: '''Integer'''}}

===$Prefer this message very highly===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message very highly</code> set.}}

===$Prefer this message highly===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message highly</code> or <code>$Prefer this message very highly</code> set.}}

===$Prefer this message===
{{Table232|
*Prefer this message to any message without <code>$Prefer this message</code>, <code>$Prefer this message highly</code> or <code>$Prefer this message very highly</code> set.}}

==#End==
{{Table3615|
The very last entry must be #End. No exceptions.}} 

==#Simulated Speech Overrides==
{{Table3613|
Optional. Used to add file names to the generic message list, which defaults to 'none', 'cuevoice', 'cue_voice', 'emptymsg', 'generic', and 'msgstart'. Filenames listed below will be overridden by Text to Speech (TTS) when it is enabled, in addition to those in the default list.}} 

===$File Name:===
{{Table3613|
Optional. File name to add to the overrides list. Filenames provided here, however, must include an extension or a warning will be issues, for example msg_1.wav.
*Syntax: '''String'''}} 

==#End==
{{Table3613|
Must also end the optional Simulated Speech Overrides section with #End.}} 

==Filters==
{{Table232|
*Messages can be filtered with [[Messages.tbl#$Filter by sender:|$Filter by sender:]], [[Messages.tbl#$Filter by subject:|$Filter by subject:]], or [[Messages.tbl#$Filter by subject:|$Filter by other ship:]].
*These can be applied multiple times for each filer. So the following example would match Vasudan or Shivan Bombers and nothing else.
<pre>
+Species: Vasudan
+Species: Shivan
+Type: Bomber
</pre>}}

===+Ship name:===
*Matches the name of the ship
*Syntax: '''''String'''''

===+Callsign:===
*Matches the callsign of the ship
*Syntax: '''''String'''''

===+Class name:===
*Matches the class of the ship
*Respects alt-names as defined in FRED
*Syntax: '''''String'''''

===+Wing name:===
*Matches the wing that the ship is in
*Syntax: '''''String'''''

===+Species:===
*Matches the species of the ship
*Syntax: '''''String'''''

===+Type:===
*Matches the type of the ship as defined in [[objecttypes.tbl]]
*Syntax: '''''String'''''

===+Team:===
*Matches the ship's team as defined in [[Iff_defs.tbl]]
*Typically used with 'other ship' filters
*Syntax: '''''String'''''

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack_shivans_suck.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )
$Filter by subject:
+Species: Shivan

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack_love_killing_shivans.wav
$Mood: Happy
$Exclude Mood: ( "Angry" "Vengeful" )
$Filter by subject:
+Species: Shivan

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

$Name: Attack Target
$Message: XSTR("Affirmative. Bombing run commencing.", 2802)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack_bombing.wav
$Filter by sender:
+Type: Bomber
$Filter by subject:
+Type: Transport
+Type: Freighter
+Type: AWACS
+Type: Gas Miner
+Type: Cruiser
+Type: Corvette
+Type: Capital
+Type: Super Cap
+Type: Drydock

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

; These line won't be used unless $Allow Any Ship To Send Backup Messages: is turned on.

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

; This line will be used, since it has a filter.

$Name: Backup
$Message: XSTR("Omega wing on station. Request permission to kick ass.", 2803)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup_omega.wav
$Filter by sender:
+Wing: Omega

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

; Or equivalently...
; $Name: Delta Arrived
; $Message: XSTR("This is Delta wing. What's your status?", 2772)
; +Persona: Wingman 1
; +Avi Name: Head-TP1
; +Wave Name: 1_Delta.wav
; $Filter by sender:
; +Wing: Delta

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

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