Difference between revisions of "Species defs.tbl"

From FreeSpace Wiki
Jump to: navigation, search
m (Fixed some little details)
(+Shield_Hit_ani:)
 
(25 intermediate revisions by 10 users not shown)
Line 1: Line 1:
Species_defs.tbl is a new table added by the Source Code Project which allows the addition of new species types in addition to Terran, Vasudan and Shivan, or to replace these three species. New species can have individual briefing icons, thruster glows, shield hit anis, debris fields, and [[FRED]] menu colours. Any new species added here must be added to [[icons.tbl]], [[asteroid.tbl]] and [[sounds.tbl]] if the game is to work.
+
{{SCP_table}}
  
==Number of Species==
+
{{TableVersion|10131}}
*Defines the number of species that are created with species_defs.tbl
+
 
*'''$NumSpecies:'''
+
The '''species_defs.tbl''' is a new table added by the Source Code Project which allows the addition of new species types in addition to Terran, Vasudan and Shivan, or to replace these three species. New species can have individual briefing icons, thruster glows, shield hit anis, debris fields, and [[FRED]] menu colours. Any new species added here must be added to [[icons.tbl]], [[asteroid.tbl]] and [[sounds.tbl]] if the game is to work.
**Syntax: ''Value''
+
 
 +
 
 +
This table is one of the [[Modular Tables]] and can be extended with xxx-sdf.tbm
 +
 
 +
[[Tables|List of Tables]]
  
 
==Species Entry==
 
==Species Entry==
 +
  
 
===$Species_Name:===
 
===$Species_Name:===
 +
{{Table3610|
 
*Defines the name of the species.
 
*Defines the name of the species.
*Syntax: ''Name''
+
*Syntax: '''String'''
**Example: ''Shivan''
+
**Example: ''Shivan''}}
 +
 
  
 
===$Default IFF:===
 
===$Default IFF:===
 +
{{Table3610|
 
*Defines the species default IFF in FRED.
 
*Defines the species default IFF in FRED.
*Friendly, Hostile, Neutral ...??
+
*Syntax: '''String''', name of the IFF, either as default IFF types or as define in [[iff_defs.tbl]]
*Syntax: ''IFF''
+
**Example: ''Hostile''}}
**Example: ''Hostile''
+
 
  
===$FRED Color===
+
===$FRED Color::===
 +
{{Table3610|
 +
*Also '''$FRED Colour:'''
 
*Defines the color used in FRED for this species
 
*Defines the color used in FRED for this species
 
*If not defined the fred defaults color to black ( 0, 0, 0 )
 
*If not defined the fred defaults color to black ( 0, 0, 0 )
*Syntax: ( ''Value, Value, Value'' ), (red, green and blue respectively
+
*Syntax: ( '''Color''' ), three '''integers''', 0 to 255, red, green and blue respectively
**Example: ( 255, 0, 0 )
+
**Example: ( 255, 0, 0 )}}
 +
 
  
 
===+Debris_Texture:===
 
===+Debris_Texture:===
*Defines the name of the standard texture applied to species specific debris fields.
+
{{Table3610|
*Syntax: ''Name''
+
*Defines the name of the standard texture applied to particle-like impact-effect and 'vaporized' ship debris.
**Example: ''debris01c''
+
*Syntax: '''String''', filename
 +
**Example: ''debris01c''}}
  
 
===+Shield_Hit_ani:===
 
===+Shield_Hit_ani:===
*Defines the name of the ani file applied to a species shields when hit.
+
{{Table3610|
*Syntax: ''Name''
+
*Defines the name of the ani file projected to a species shield mesh when hit.
**Example: ''shivanshield''
+
*Syntax: '''String''', filename
 +
**Example: ''shivanshield''}}
 +
{{note|The animations fps value is ignored, instead any animation plays for 0.75 secs with all frames playing at equal intervals. Additionally, only the first 75% of the animations frames are currently used (a bug!)}}
 +
{{note|The retail shieldhit01a.ani has 21 frames and 30 fps, which if it were not ignored would mean a playtime of 0.7secs}}
  
 
===$ThrustAnims:===
 
===$ThrustAnims:===
*'''+Pri_Normal:'''
+
{{Table3610|
 +
*'''+Normal:''' or '''+Pri_Normal:'''
 
**Defines name of standard thruster animation.
 
**Defines name of standard thruster animation.
**Syntax: ''Name''
+
**This maps the image onto the mesh thrusters.
 +
**Syntax: '''String''', filename or ''<none>''
 
***Example: ''thruster03''
 
***Example: ''thruster03''
*'''+Pri_Afterburn:'''
+
*'''+Afterburn:''' or '''+Pri_Afterburn:'''
 
**Defines name of afterburn thruster animation.
 
**Defines name of afterburn thruster animation.
**Syntax: ''Name''
+
**This maps the image onto the mesh thrusters.
 +
**Syntax: '''String''', filename or ''<none>''
 
***Example: ''thruster03a''
 
***Example: ''thruster03a''
 
*'''+Sec_Normal:'''
 
*'''+Sec_Normal:'''
 
**Defines name of secondary standard thruster animation.
 
**Defines name of secondary standard thruster animation.
**Syntax: ''Name''
+
**This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
 +
**Syntax: '''String''', filename
 
***Example: ''thruster02-03''
 
***Example: ''thruster02-03''
 
*'''+Sec_Afterburn:'''
 
*'''+Sec_Afterburn:'''
 
**Defines name of secondary afterburn thruster animation.
 
**Defines name of secondary afterburn thruster animation.
**Syntax: ''Name''
+
**This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
 +
**Syntax: '''String''', filename
 
***Example: ''thruster02-03a''
 
***Example: ''thruster02-03a''
 
*'''+Ter_Normal:'''
 
*'''+Ter_Normal:'''
 
**Defines name of tertiary standard thruster animation.
 
**Defines name of tertiary standard thruster animation.
**Syntax: ''Name''
+
**This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers in size.
 +
**Syntax: '''String''', filename
 
***Example: ''thruster03-03''
 
***Example: ''thruster03-03''
 
*'''+Ter_Afterburn:'''
 
*'''+Ter_Afterburn:'''
 
**Defines name of tertiary afterburn thruster animation.
 
**Defines name of tertiary afterburn thruster animation.
**Syntax: ''Name''
+
**This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers.
***Example: ''thruster03-03a''
+
**Syntax: '''String''', filename
 +
***Example: ''thruster03-03a''}}
 +
{{Table3613|
 +
*'''+Dist_Normal:'''
 +
**Defines name of normal thruster distortion envelope animation.
 +
**This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
 +
**Syntax: '''String''', filename
 +
***Example: ''thruster02-03''
 +
*'''+Dist_Afterburn:'''
 +
**Defines name of afterburner thruster distortion envelope animation.
 +
**This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
 +
**Syntax: '''String''', filename
 +
***Example: ''thruster02-03a''}}
  
 
===$ThrustGlows:===
 
===$ThrustGlows:===
 +
{{Table3610|
 
*'''+Normal:'''
 
*'''+Normal:'''
 
**Defines name of standard thruster glow bitmap.
 
**Defines name of standard thruster glow bitmap.
**Syntax: ''Name''
+
**Syntax: '''String''', filename or ''<none>''
 
***Example: ''thrusterglow03''
 
***Example: ''thrusterglow03''
 
*'''+Afterburn:'''
 
*'''+Afterburn:'''
 
**Defines name of standard thruster glow bitmap.
 
**Defines name of standard thruster glow bitmap.
**Syntax: ''Name''
+
**Syntax: '''String''', filename or ''<none>''
***Example: ''thrusterglow03a''
+
***Example: ''thrusterglow03a''}}
 +
 
  
 
===$AwacsMultiplier:===
 
===$AwacsMultiplier:===
*Defines the awacs effectiveness multiplier. ???
+
{{Table3610|
*Syntax: ''Value'', (multiplier)
+
*Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number.
**Example: ''1.25''
+
*Syntax: '''Float''', (multiplier)
 +
**Example: ''1.25''}}
 +
 
 +
===$Countermeasure Type:===
 +
{{Table371|
 +
*Works just like the $Countermeasure Type: on a ship class basis.  If you specify one for the species, you won't have to specify one for each ship class of that species.}}
  
 
==Sample Entry==
 
==Sample Entry==
  
  #SPECIES DEFS
+
<pre>
   $NumSpecies: 1
+
#SPECIES DEFS
  $Species_Name:         Shivan
+
 
  $Default IFF:           Hostile
+
;------------------------
  $FRED Color:           ( 255, 0, 0 )
+
; Terran
      +Debris_Texture:     debris01c
+
;------------------------
      +Shield_Hit_ani:     shivanshield
+
$Species_Name: Terran
  $ThrustAnims:
+
$Default IFF: Friendly
      +Pri_Normal:         thruster03
+
$FRED Color: ( 0, 0, 192 )
      +Pri_Afterburn:     thruster03a
+
$MiscAnims:
      +Sec_Normal:         thruster02-03
+
   +Debris_Texture: debris01a
      +Sec_Afterburn:     thruster02-03a
+
  +Shield_Hit_ani: shieldhit01a
      +Ter_Normal:         thruster03-03
+
$ThrustAnims:
      +Ter_Afterburn:     thruster03-03a
+
  +Normal: thruster01
   $ThrustGlows:
+
  +Afterburn: thruster01a
      +Normal:             thrusterglow03
+
$ThrustGlows:
      +Afterburn:         thrusterglow03a
+
  +Normal: thrusterglow01
  $AwacsMultiplier:       1.25
+
  +Afterburn: thrusterglow01a
  #End
+
$AwacsMultiplier: 1.00
 +
 
 +
;------------------------
 +
; Vasudan
 +
;------------------------
 +
$Species_Name: Vasudan
 +
$Default IFF: Friendly
 +
$FRED Color: ( 0, 128, 0 )
 +
$MiscAnims:
 +
  +Debris_Texture: debris01b
 +
  +Shield_Hit_ani: shieldhit01a
 +
$ThrustAnims:
 +
  +Normal: thruster02
 +
  +Afterburn: thruster02a
 +
$ThrustGlows:
 +
  +Normal: thrusterglow02
 +
  +Afterburn: thrusterglow02a
 +
$AwacsMultiplier: 1.25
 +
 
 +
;------------------------
 +
; Shivan
 +
;------------------------
 +
$Species_Name: Shivan
 +
$Default IFF: Hostile
 +
$FRED Color: ( 192, 0, 0 )
 +
$MiscAnims:
 +
  +Debris_Texture: debris01c
 +
  +Shield_Hit_ani: shieldhit01a
 +
$ThrustAnims:
 +
  +Normal: thruster03
 +
   +Afterburn: thruster03a
 +
$ThrustGlows:
 +
  +Normal: thrusterglow03
 +
  +Afterburn: thrusterglow03a
 +
$AwacsMultiplier: 1.50
 +
 
 +
#END
 +
</pre>
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Latest revision as of 05:23, 28 December 2015

This feature requires SCP

Revision information.....

FSO Revision: 10131
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version


The species_defs.tbl is a new table added by the Source Code Project which allows the addition of new species types in addition to Terran, Vasudan and Shivan, or to replace these three species. New species can have individual briefing icons, thruster glows, shield hit anis, debris fields, and FRED menu colours. Any new species added here must be added to icons.tbl, asteroid.tbl and sounds.tbl if the game is to work.


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

List of Tables

Species Entry

$Species_Name:

FS2 Open 3.6.10:
  • Defines the name of the species.
  • Syntax: String
    • Example: Shivan


$Default IFF:

FS2 Open 3.6.10:
  • Defines the species default IFF in FRED.
  • Syntax: String, name of the IFF, either as default IFF types or as define in iff_defs.tbl
    • Example: Hostile


$FRED Color::

FS2 Open 3.6.10:
  • Also $FRED Colour:
  • Defines the color used in FRED for this species
  • If not defined the fred defaults color to black ( 0, 0, 0 )
  • Syntax: ( Color ), three integers, 0 to 255, red, green and blue respectively
    • Example: ( 255, 0, 0 )


+Debris_Texture:

FS2 Open 3.6.10:
  • Defines the name of the standard texture applied to particle-like impact-effect and 'vaporized' ship debris.
  • Syntax: String, filename
    • Example: debris01c

+Shield_Hit_ani:

FS2 Open 3.6.10:
  • Defines the name of the ani file projected to a species shield mesh when hit.
  • Syntax: String, filename
    • Example: shivanshield
Note: The animations fps value is ignored, instead any animation plays for 0.75 secs with all frames playing at equal intervals. Additionally, only the first 75% of the animations frames are currently used (a bug!)
Note: The retail shieldhit01a.ani has 21 frames and 30 fps, which if it were not ignored would mean a playtime of 0.7secs

$ThrustAnims:

FS2 Open 3.6.10:
  • +Normal: or +Pri_Normal:
    • Defines name of standard thruster animation.
    • This maps the image onto the mesh thrusters.
    • Syntax: String, filename or <none>
      • Example: thruster03
  • +Afterburn: or +Pri_Afterburn:
    • Defines name of afterburn thruster animation.
    • This maps the image onto the mesh thrusters.
    • Syntax: String, filename or <none>
      • Example: thruster03a
  • +Sec_Normal:
    • Defines name of secondary standard thruster animation.
    • This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
    • Syntax: String, filename
      • Example: thruster02-03
  • +Sec_Afterburn:
    • Defines name of secondary afterburn thruster animation.
    • This is rendered as a plane, the image is centered but on the left edge of the image, and located at each of the engines. This causes the image to flicker in size. it also grows and shrinks depending on the thrust.
    • Syntax: String, filename
      • Example: thruster02-03a
  • +Ter_Normal:
    • Defines name of tertiary standard thruster animation.
    • This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers in size.
    • Syntax: String, filename
      • Example: thruster03-03
  • +Ter_Afterburn:
    • Defines name of tertiary afterburn thruster animation.
    • This is rendered as a halo, the image is centered, and located at each of the engines. This will always be facing the player directly. Used for an engine glow that flickers.
    • Syntax: String, filename
      • Example: thruster03-03a
FS2 Open, 3.6.14:
  • +Dist_Normal:
    • Defines name of normal thruster distortion envelope animation.
    • This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
    • Syntax: String, filename
      • Example: thruster02-03
  • +Dist_Afterburn:
    • Defines name of afterburner thruster distortion envelope animation.
    • This is the alpha envelope of the thruster distortion. It will take the brightness of the texture multiply it by 10 and use that as the alpha value for the distortion effect.
    • Syntax: String, filename
      • Example: thruster02-03a

$ThrustGlows:

FS2 Open 3.6.10:
  • +Normal:
    • Defines name of standard thruster glow bitmap.
    • Syntax: String, filename or <none>
      • Example: thrusterglow03
  • +Afterburn:
    • Defines name of standard thruster glow bitmap.
    • Syntax: String, filename or <none>
      • Example: thrusterglow03a


$AwacsMultiplier:

FS2 Open 3.6.10:
  • Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number.
  • Syntax: Float, (multiplier)
    • Example: 1.25

$Countermeasure Type:

FS2 Open, 3.7.2:
  • Works just like the $Countermeasure Type: on a ship class basis. If you specify one for the species, you won't have to specify one for each ship class of that species.

Sample Entry

#SPECIES DEFS

;------------------------
; Terran
;------------------------
$Species_Name: Terran
$Default IFF: Friendly
$FRED Color: ( 0, 0, 192 )
$MiscAnims:
   +Debris_Texture: debris01a
   +Shield_Hit_ani: shieldhit01a
$ThrustAnims:
   +Normal: thruster01
   +Afterburn: thruster01a
$ThrustGlows:
   +Normal: thrusterglow01
   +Afterburn: thrusterglow01a
$AwacsMultiplier: 1.00

;------------------------
; Vasudan
;------------------------
$Species_Name: Vasudan
$Default IFF: Friendly
$FRED Color: ( 0, 128, 0 )
$MiscAnims:
   +Debris_Texture: debris01b
   +Shield_Hit_ani: shieldhit01a
$ThrustAnims:
   +Normal: thruster02
   +Afterburn: thruster02a
$ThrustGlows:
   +Normal: thrusterglow02
   +Afterburn: thrusterglow02a
$AwacsMultiplier: 1.25

;------------------------
; Shivan
;------------------------
$Species_Name: Shivan
$Default IFF: Hostile
$FRED Color: ( 192, 0, 0 )
$MiscAnims:
   +Debris_Texture: debris01c
   +Shield_Hit_ani: shieldhit01a
$ThrustAnims:
   +Normal: thruster03
   +Afterburn: thruster03a
$ThrustGlows:
   +Normal: thrusterglow03
   +Afterburn: thrusterglow03a
$AwacsMultiplier: 1.50

#END