Difference between revisions of "Ssm.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Added "+Alarm Sound:")
(Adding modular SSM tables.)
Line 1: Line 1:
{{TableVersion|4879}}
+
{{TableVersionGit|2015-05-26|258662ff4c}}
  
The '''ssm.tbl''' was originally meant for defining the flight behavior of subspace missiles (SSM).  
+
The '''ssm.tbl''' was originally meant for defining the flight behavior of subspace missiles (SSM).
  
 +
 +
This table is one of the [[Modular Tables]] and can be extended with xxx-ssm.tbm
  
 
[[Tables|List of Tables]]
 
[[Tables|List of Tables]]
  
 
==Format==
 
==Format==
*Table consist of independent '''$SSM:''' entries
+
*Table consists of independent '''$SSM:''' entries
*Table ends to '''#end'''
+
*Table ends with '''#end'''
  
  
Line 15: Line 17:
  
 
==$SSM:==
 
==$SSM:==
 +
*Names the SSM strike.
 +
*Syntax: '''String''', name of the strike (as used by SEXPs and weapons)
  
  
 
===+Weapon:===
 
===+Weapon:===
*Defines weapon used  
+
*Defines the weapon used in the strike.
 
*Syntax: '''String''', name of the weapon
 
*Syntax: '''String''', name of the weapon
  
  
 
===+Count:===
 
===+Count:===
*Defines number of the missiles
+
* (Optional) Defines number of the weapons fired by the strike.
*Syntax: '''Integer'''
+
*Syntax: '''Integer''', defaults to 1
  
  
 
===+WarpRadius:===
 
===+WarpRadius:===
*Defines the warp radius used by the missiles
+
*Defines the radius of the warp effect.
 
*Syntax: '''Float'''
 
*Syntax: '''Float'''
  
  
 
===+WarpTime:===
 
===+WarpTime:===
*Defines the time between deployment and arrival
+
* (Optional) Defines the lifetime of the warp effect in seconds. Non-beam weapons fire halfway through this lifetime; beam weapons either fire at the start of the effect or at the appropriate time so that the midpoint of the beam is the same as the midpoint of the warp effect, whichever is later.
*Syntax: '''Float'''
+
*Syntax: '''Float''', defaults to 4.0
  
  
 
===+Radius:===
 
===+Radius:===
*Defines radius of the missiles arrival cone
+
*Defines the radius of the formation used by the weapons in the strike.
 
*Syntax: '''Float'''
 
*Syntax: '''Float'''
  
  
 
===+Offset:===
 
===+Offset:===
*Defines offset of the cone (probably)
+
* (Optional) Defines the offset of the formation used by the weapons in the strike; generally works best with circular strikes.
*Syntax: '''Float'''
+
*Syntax: '''Float''', defaults to 0
 +
 
 +
 
 +
===+Shape:===
 +
{{Table373|
 +
* (Optional) The shape used for the formation of weapons.
 +
*Syntax: '''Point''', '''Circle''', or '''Sphere'''; defaults to Circle}}
 +
 
  
 
===+HUD Message:===
 
===+HUD Message:===
*Whether or not firing this SSM triggers a HUD message. Default is true.
+
* (Optional) Whether or not firing this SSM triggers a HUD message.
*Syntax: '''Boolean'''
+
*Syntax: '''Boolean''', defaults to true
 +
 
  
 
===+Custom Message:===
 
===+Custom Message:===
*Can be used to define a custom message to be triggered when the SSM is fired.
+
* (Optional) Can be used to define a custom message to be triggered when the SSM is fired.
 
*Syntax: '''String'''
 
*Syntax: '''String'''
 
*Note: By default, the message played is the one defined in strings.tbl index 1570, which is set to the generic "Firing Artillery"
 
*Note: By default, the message played is the one defined in strings.tbl index 1570, which is set to the generic "Firing Artillery"
 +
  
 
===+Alarm Sound:===
 
===+Alarm Sound:===
 
{{Table371|
 
{{Table371|
*Can be used to define a custom alarm sound to be played when the SSM is fired.
+
* (Optional) Can be used to define a custom alarm sound to be played when the SSM is fired.
 
*Syntax: '''Integer'''}}
 
*Syntax: '''Integer'''}}
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 01:25, 29 May 2015

Revision information.....

FSO Git Commit: Date:2015-05-26 SHA:258662ff4c
Note: Please update the revision information when the page is updated. If your edit had nothing to do with new code entries then please do not edit the revision information


The ssm.tbl was originally meant for defining the flight behavior of subspace missiles (SSM).


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

List of Tables

Format

  • Table consists of independent $SSM: entries
  • Table ends with #end


Table Entries

$SSM:

  • Names the SSM strike.
  • Syntax: String, name of the strike (as used by SEXPs and weapons)


+Weapon:

  • Defines the weapon used in the strike.
  • Syntax: String, name of the weapon


+Count:

  • (Optional) Defines number of the weapons fired by the strike.
  • Syntax: Integer, defaults to 1


+WarpRadius:

  • Defines the radius of the warp effect.
  • Syntax: Float


+WarpTime:

  • (Optional) Defines the lifetime of the warp effect in seconds. Non-beam weapons fire halfway through this lifetime; beam weapons either fire at the start of the effect or at the appropriate time so that the midpoint of the beam is the same as the midpoint of the warp effect, whichever is later.
  • Syntax: Float, defaults to 4.0


+Radius:

  • Defines the radius of the formation used by the weapons in the strike.
  • Syntax: Float


+Offset:

  • (Optional) Defines the offset of the formation used by the weapons in the strike; generally works best with circular strikes.
  • Syntax: Float, defaults to 0


+Shape:

FS2 Open, 3.7.4:
  • (Optional) The shape used for the formation of weapons.
  • Syntax: Point, Circle, or Sphere; defaults to Circle


+HUD Message:

  • (Optional) Whether or not firing this SSM triggers a HUD message.
  • Syntax: Boolean, defaults to true


+Custom Message:

  • (Optional) Can be used to define a custom message to be triggered when the SSM is fired.
  • Syntax: String
  • Note: By default, the message played is the one defined in strings.tbl index 1570, which is set to the generic "Firing Artillery"


+Alarm Sound:

FS2 Open, 3.7.2:
  • (Optional) Can be used to define a custom alarm sound to be played when the SSM is fired.
  • Syntax: Integer