Difference between revisions of "Species defs.tbl"
From FreeSpace Wiki
Einstine909 (talk | contribs) (→$ThrustAnims:) |
m (version info) |
||
Line 1: | Line 1: | ||
− | ''''' | + | {{SCP_table}} |
− | + | ||
+ | |||
+ | Revision information.. <!-- Please update this information when page is updated --> | ||
+ | ::'''3.6.x branch:''' 1.32.2.3 | ||
+ | ::'''3.7 branch:''' 1.37 | ||
+ | |||
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_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 Entry== | ||
+ | |||
===$Species_Name:=== | ===$Species_Name:=== | ||
+ | {{Table36| | ||
*Defines the name of the species. | *Defines the name of the species. | ||
− | *Syntax: '' | + | *Syntax: '''String''' |
− | **Example: ''Shivan'' | + | **Example: ''Shivan''}} |
+ | |||
===$Default IFF:=== | ===$Default IFF:=== | ||
+ | {{Table36| | ||
*Defines the species default IFF in FRED. | *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]] | |
− | *Syntax: '' | + | **Example: ''Hostile''}} |
− | **Example: ''Hostile'' | ||
− | ===$FRED Color: | + | |
+ | ===$FRED Color::=== | ||
+ | {{Table36| | ||
+ | *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: ( '' | + | *Syntax: ( '''Color''' ), three '''integers''', 0 to 255, red, green and blue respectively |
− | **Example: ( 255, 0, 0 ) | + | **Example: ( 255, 0, 0 )}} |
+ | |||
===+Debris_Texture:=== | ===+Debris_Texture:=== | ||
+ | {{Table36| | ||
*Defines the name of the standard texture applied to species specific debris fields. | *Defines the name of the standard texture applied to species specific debris fields. | ||
− | *Syntax: '' | + | *Syntax: '''String''', filename |
− | **Example: ''debris01c'' | + | **Example: ''debris01c''}} |
===+Shield_Hit_ani:=== | ===+Shield_Hit_ani:=== | ||
+ | {{Table36| | ||
*Defines the name of the ani file applied to a species shields when hit. | *Defines the name of the ani file applied to a species shields when hit. | ||
− | *Syntax: '' | + | *Syntax: '''String''', filename |
− | **Example: ''shivanshield'' | + | **Example: ''shivanshield''}} |
+ | |||
===$ThrustAnims:=== | ===$ThrustAnims:=== | ||
+ | {{Table36| | ||
*'''+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. | **This maps the image onto the mesh thrusters. | ||
− | **Syntax: '' | + | **Syntax: '''String''', filename 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. | **This maps the image onto the mesh thrusters. | ||
− | **Syntax: '' | + | **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. | ||
**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. | **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: '' | + | **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. | ||
**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. | **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: '' | + | **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. | ||
**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. | **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: '' | + | **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. | ||
**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. | **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: '' | + | **Syntax: '''String''', filename |
− | ***Example: ''thruster03-03a'' | + | ***Example: ''thruster03-03a''}} |
+ | |||
===$ThrustGlows:=== | ===$ThrustGlows:=== | ||
+ | {{Table36| | ||
*'''+Normal:''' | *'''+Normal:''' | ||
**Defines name of standard thruster glow bitmap. | **Defines name of standard thruster glow bitmap. | ||
− | **Syntax: '' | + | **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: '' | + | **Syntax: '''String''', filename or ''<none>'' |
− | ***Example: ''thrusterglow03a'' | + | ***Example: ''thrusterglow03a''}} |
+ | |||
===$AwacsMultiplier:=== | ===$AwacsMultiplier:=== | ||
+ | {{Table36| | ||
*Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number. | *Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number. | ||
− | *Syntax: '' | + | *Syntax: '''Float''', (multiplier) |
− | **Example: ''1.25'' | + | **Example: ''1.25''}} |
+ | |||
==Sample Entry== | ==Sample Entry== | ||
− | + | <pre> | |
− | + | #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 | |
− | #END | + | ;------------------------ |
+ | ; 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]] |
Revision as of 17:01, 30 July 2007
This feature requires FreeSpace Open |
Revision information..
- 3.6.x branch: 1.32.2.3
- 3.7 branch: 1.37
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.
Contents
Species Entry
$Species_Name:
FS2 Open, 3.6.x:
- Defines the name of the species.
- Syntax: String
- Example: Shivan
$Default IFF:
FS2 Open, 3.6.x:
- 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.x:
- 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.x:
- Defines the name of the standard texture applied to species specific debris fields.
- Syntax: String, filename
- Example: debris01c
+Shield_Hit_ani:
FS2 Open, 3.6.x:
- Defines the name of the ani file applied to a species shields when hit.
- Syntax: String, filename
- Example: shivanshield
$ThrustAnims:
FS2 Open, 3.6.x:
- +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
$ThrustGlows:
FS2 Open, 3.6.x:
- +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.x:
- Defines the awacs multiplier. All ships belonging to the species have their awacs range multiplied by this number.
- Syntax: Float, (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