Difference between revisions of "Ssm.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Adding modular SSM tables.)
(Forgot the randomization upgrades.)
Line 1: Line 1:
{{TableVersionGit|2015-05-26|258662ff4c}}
+
{{TableVersionGit|2015-08-24|abd31038e7}}
  
 
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).
Line 18: Line 18:
 
==$SSM:==
 
==$SSM:==
 
*Names the SSM strike.
 
*Names the SSM strike.
 +
{{Table374|The name itself is optional; if not present, it gets defaulted to "SSM <index>", allowing easy selection in FRED.}}
 
*Syntax: '''String''', name of the strike (as used by SEXPs and weapons)
 
*Syntax: '''String''', name of the strike (as used by SEXPs and weapons)
  
Line 29: Line 30:
 
* (Optional) Defines number of the weapons fired by the strike.
 
* (Optional) Defines number of the weapons fired by the strike.
 
*Syntax: '''Integer''', defaults to 1
 
*Syntax: '''Integer''', defaults to 1
 +
{{Table374|
 +
===+Min Count:===
 +
* (Optional) Can be used instead of "+Count:", and in combination with "+Max Count:", to allow for a random number of weapons to be in the strike.
 +
*Syntax: '''Integer'''
 +
===+Max Count:===
 +
* (Required if "+Min Count:" is used) Specifies the maximum number of weapons that can be fired by the strike.
 +
*Syntax: '''Integer'''}}
  
  
Line 44: Line 52:
 
*Defines the radius of the formation used by the weapons in the strike.
 
*Defines the radius of the formation used by the weapons in the strike.
 
*Syntax: '''Float'''
 
*Syntax: '''Float'''
 +
{{Table374|
 +
===+Min Radius:===
 +
* (Optional) Can be used instead of "+Radius", and in combination with "+Max Radius:", to allow for a random radius to be used by the strike.
 +
*Syntax: '''Float'''
 +
===+Max Radius:===
 +
* (Required if "+Min Radius:" is used) Specifies the maximum radius of the strike formation.
 +
*Syntax: '''Float'''}}
  
  
Line 49: Line 64:
 
* (Optional) Defines the offset of the formation used by the weapons in the strike; generally works best with circular strikes.
 
* (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
 
*Syntax: '''Float''', defaults to 0
 +
{{Table374|
 +
===+Min Offset:===
 +
* (Optional) Can be used instead of "+Offset", and in combination with "+Max Offset:", to allow for a random offset to be used by the strike.
 +
*Syntax: '''Float'''
 +
===+Max Offset:===
 +
* (Required if "+Min Offset:" is used) Specifies the maximum offset of the strike formation.
 +
*Syntax: '''Float'''}}
  
  

Revision as of 22:58, 5 January 2018

Revision information.....

FSO Git Commit: Date:2015-08-24 SHA:abd31038e7
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.
FS2 Open, 3.7.4: The name itself is optional; if not present, it gets defaulted to "SSM <index>", allowing easy selection in FRED.
  • 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
FS2 Open, 3.7.4:

+Min Count:

  • (Optional) Can be used instead of "+Count:", and in combination with "+Max Count:", to allow for a random number of weapons to be in the strike.
  • Syntax: Integer

+Max Count:

  • (Required if "+Min Count:" is used) Specifies the maximum number of weapons that can be fired by the strike.
  • Syntax: Integer


+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
FS2 Open, 3.7.4:

+Min Radius:

  • (Optional) Can be used instead of "+Radius", and in combination with "+Max Radius:", to allow for a random radius to be used by the strike.
  • Syntax: Float

+Max Radius:

  • (Required if "+Min Radius:" is used) Specifies the maximum radius of the strike formation.
  • 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
FS2 Open, 3.7.4:

+Min Offset:

  • (Optional) Can be used instead of "+Offset", and in combination with "+Max Offset:", to allow for a random offset to be used by the strike.
  • Syntax: Float

+Max Offset:

  • (Required if "+Min Offset:" is used) Specifies the maximum offset of the strike formation.
  • Syntax: Float


+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