Difference between revisions of "Species defs.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Sample Entry: pruned spaces)
($ThrustAnims:)
Line 36: Line 36:
 
*'''+Normal:''' or '''+Pri_Normal:'''
 
*'''+Normal:''' or '''+Pri_Normal:'''
 
**Defines name of standard thruster animation.
 
**Defines name of standard thruster animation.
 +
**This maps the image onto the mesh thrusters.
 
**Syntax: ''Name'' or ''<none>''
 
**Syntax: ''Name'' or ''<none>''
 
***Example: ''thruster03''
 
***Example: ''thruster03''
 
*'''+Afterburn:''' or '''+Pri_Afterburn:'''
 
*'''+Afterburn:''' or '''+Pri_Afterburn:'''
 
**Defines name of afterburn thruster animation.
 
**Defines name of afterburn thruster animation.
 +
**This maps the image onto the mesh thrusters.
 
**Syntax: ''Name'' or ''<none>''
 
**Syntax: ''Name'' or ''<none>''
 
***Example: ''thruster03a''
 
***Example: ''thruster03a''
 
*'''+Sec_Normal:'''
 
*'''+Sec_Normal:'''
 
**Defines name of secondary standard thruster animation.
 
**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: ''Name''
 
**Syntax: ''Name''
 
***Example: ''thruster02-03''
 
***Example: ''thruster02-03''
 
*'''+Sec_Afterburn:'''
 
*'''+Sec_Afterburn:'''
 
**Defines name of secondary afterburn thruster animation.
 
**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: ''Name''
 
**Syntax: ''Name''
 
***Example: ''thruster02-03a''
 
***Example: ''thruster02-03a''
 
*'''+Ter_Normal:'''
 
*'''+Ter_Normal:'''
 
**Defines name of tertiary standard thruster animation.
 
**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: ''Name''
 
**Syntax: ''Name''
 
***Example: ''thruster03-03''
 
***Example: ''thruster03-03''
 
*'''+Ter_Afterburn:'''
 
*'''+Ter_Afterburn:'''
 
**Defines name of tertiary afterburn thruster animation.
 
**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: ''Name''
 
**Syntax: ''Name''
 
***Example: ''thruster03-03a''
 
***Example: ''thruster03-03a''

Revision as of 20:50, 6 May 2007

This feature requires SCP


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.

Species Entry

$Species_Name:

  • Defines the name of the species.
  • Syntax: Name
    • Example: Shivan

$Default IFF:

  • Defines the species default IFF in FRED.
  • Friendly, Hostile, Neutral ...??
  • Syntax: IFF
    • Example: Hostile

$FRED Color: or $FRED Colour:

  • Defines the color used in FRED for this species
  • If not defined the fred defaults color to black ( 0, 0, 0 )
  • Syntax: ( Value, Value, Value ), (red, green and blue respectively)
    • Example: ( 255, 0, 0 )

+Debris_Texture:

  • Defines the name of the standard texture applied to species specific debris fields.
  • Syntax: Name
    • Example: debris01c

+Shield_Hit_ani:

  • Defines the name of the ani file applied to a species shields when hit.
  • Syntax: Name
    • Example: shivanshield

$ThrustAnims:

  • +Normal: or +Pri_Normal:
    • Defines name of standard thruster animation.
    • This maps the image onto the mesh thrusters.
    • Syntax: Name or <none>
      • Example: thruster03
  • +Afterburn: or +Pri_Afterburn:
    • Defines name of afterburn thruster animation.
    • This maps the image onto the mesh thrusters.
    • Syntax: Name 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: Name
      • 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: Name
      • 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: Name
      • 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: Name
      • Example: thruster03-03a

$ThrustGlows:

  • +Normal:
    • Defines name of standard thruster glow bitmap.
    • Syntax: Name or <none>
      • Example: thrusterglow03
  • +Afterburn:
    • Defines name of standard thruster glow bitmap.
    • Syntax: Name or <none>
      • Example: thrusterglow03a

$AwacsMultiplier:

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

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