Difference between revisions of "Fireball.tbl"

From FreeSpace Wiki
Jump to: navigation, search
m (added the light color)
m (update)
Line 1: Line 1:
 +
Revision information.. <!-- Please update this information when page is updated -->
 +
::'''3.6.x branch:''' 2.33.2.3
 +
::'''3.7 branch:''' 2.37
 +
 +
 +
This table is used to define the usage of animations with certain special effects in game.
 +
 
==General Format==
 
==General Format==
 
*Fireball.tbl table file us used for specifying which filenames are to be used for which explosions
 
*Fireball.tbl table file us used for specifying which filenames are to be used for which explosions
−
*'''#Start'''
+
*For the modular version of the fireball table, after the '''$Name:''' entry, there are 6 possible options and at least one is required. These special entries are neither required nor supported in the standard fireball.tbl file, they are only for TBMs.  No entry in the modular table will ever be created since there can only be 6 options currently, they are only listed to modify an existing entry.  None of the 6 options are required in any order and you don't have to list all 6 in one TBM.
 +
*Table begins with '''#Start'''
 
*Table uses rigid system in the order of the entries:
 
*Table uses rigid system in the order of the entries:
−
**Fireball.tbl has 6 entries with a specific function and every one '''''is required''''' and must be listed in the following order:
+
*'''''Fireball.tbl''''' has 6 entries with a specific function and every one '''''is required''''' and must be listed in the following order.
−
***'''Medium sized explosion'''
+
*'''''xxx-fbl.tbm''''' doesn't need to have the entries listed in specific order, see [[fireball.tbl#Fireball_identifier|fireball identifier]].
−
***'''Normal warp effect'''
+
*Order of the entries in fireball.tbl:
−
***'''Knossos warp effect'''
+
**'''Medium sized explosion'''
−
***'''Asteroid explosion'''
+
**'''Normal warp effect'''
−
***'''Large explosion 1'''
+
**'''Knossos warp effect'''
−
***'''Large explosion 2'''
+
**'''Asteroid explosion'''
−
***An optional '''$LOD:''' entry exists to specify a lod count, at least 1 is assumed if not specified.
+
**'''Large explosion 1'''
−
****Syntax: ''Value''
+
**'''Large explosion 2'''
−
***Optional '''$Light Color:''' entry is used to set the color that is given off when that explosion is created.
+
*Table ends to '''#End'''
−
****Syntax: ''Value'', ''Value'', ''Value'' (RGB value, 0 to 255)
+
 
−
*'''#End'''
+
 
 +
===$Name:===
 +
*Defines the name of the animation used for the particular fireball effect
 +
**Syntax: '''String''', filename
 +
 
 +
 
 +
===Fireball identifier===
 +
{{Table36|
 +
*Identifies the assigned animation with one of the fireball types.  
 +
**Syntax: '''String''', name of the identifier
 +
**Allowed identifiers:
 +
:::'''+Explosion_Medium'''
 +
:::'''+Warp_Effect'''
 +
:::'''+Knossos_Effect'''
 +
:::'''+Asteroid'''
 +
:::'''+Explosion_Large1'''
 +
:::'''+Explosion_Large2'''}}
 +
 
 +
 
 +
===$LOD:===
 +
*Optional '''$LOD:''' entry exists to specify a lod count, at least 1 is assumed if not specified.
 +
**Syntax: '''Integer'''
 +
 
  
−
===Default colors===
+
===$Light Color:===
 +
{{Table36|
 +
*Defines the color that is given off when that fireball effect is created.
 +
**Syntax: '''Color''', three '''integers''', 0 to 255, red, green, blue respectively}}
 +
 
 +
 
 +
====Default colors====
 +
{{Table36|
 
*''Large explosion 1'', ''large explosion 1'', ''medium sized explosion'', and ''asteroid explosion''
 
*''Large explosion 1'', ''large explosion 1'', ''medium sized explosion'', and ''asteroid explosion''
 
**255, 127, 31
 
**255, 127, 31
Line 22: Line 59:
 
**191, 191, 255
 
**191, 191, 255
 
*''Knossos warp effect''
 
*''Knossos warp effect''
−
**191, 255, 191
+
**191, 255, 191}}
  
−
==Sample Entry==
 
  
−
  #Start
+
==Sample Entries==
−
  $Name:  exp04
 
−
      $LOD:    1
 
−
  $Name:  WarpMap01
 
−
      $LOD:    4
 
−
  $Name:  WarpMap02
 
−
      $LOD:    4
 
−
  $Name:  exp05
 
−
      $LOD:    4
 
−
  $Name:  exp05
 
−
      $LOD:    4
 
−
  $Name:  exp06
 
−
      $LOD:    4
 
−
  #End
 
  
−
<font color=red>
+
*'''fireball.tbl'''
−
==Modular Fireball Table==
+
<pre>
−
*'''''xxx-fbl.tbm'''''
+
#Start
−
*For the modular version of the fireball table, after the $Name: entry, there are 6 possible options and at least one is required. These special entries are neither required nor supported in the standard fireball.tbl file, they are only for TBMs.  No entry in the modular table will ever be created since there can only be 6 options currently, they are only listed to modify an existing entry.  None of the 6 options are required in any order and you don't have to list all 6 in one TBM.
+
$Name:   exp04
−
**'''+Explosion_Medium'''
+
  $LOD:    1
−
***Specified name and LOD count will be used for the medium explosion effect
+
$Name:  WarpMap01
−
**'''+Warp_Effect'''
+
  $LOD:    4
−
***Specified name and LOD count used for the normal warp effect
+
$Name:  WarpMap02
−
**'''+Knossos_Effect'''
+
  $LOD:    4
−
***Specified name and LOD count for the knossos/special warp effect
+
$Name:  exp05
−
**'''+Asteroid'''
+
  $LOD:    4
−
***Specifiedname and LOD count for asteroid explosions
+
$Name:  exp05
−
**'''+Explosion_Large1'''
+
  $LOD:    4
−
***Specified name and LOD count for the 1st of the large explosions
+
$Name:  exp06
−
**'''+Explosion_Large2'''
+
  $LOD:    4
−
***Specified name and LOD count for the 2nd of the large explosions
+
#End
 +
</pre>
  
−
==Sample Entry==
 
  
−
  #Start
+
{{Table36|
−
  $Name:  exp06
+
'''xxx-fbl.tbm'''
−
      +Asteroid
+
<pre>
−
  $LOD:    4
+
#Start
−
  #End
+
$Name:  exp06
−
</font>
+
  +Asteroid
 +
$LOD:    4
 +
#End
 +
</pre>}}
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 11:28, 30 July 2007

Revision information..

3.6.x branch: 2.33.2.3
3.7 branch: 2.37


This table is used to define the usage of animations with certain special effects in game.

General Format

  • Fireball.tbl table file us used for specifying which filenames are to be used for which explosions
  • For the modular version of the fireball table, after the $Name: entry, there are 6 possible options and at least one is required. These special entries are neither required nor supported in the standard fireball.tbl file, they are only for TBMs. No entry in the modular table will ever be created since there can only be 6 options currently, they are only listed to modify an existing entry. None of the 6 options are required in any order and you don't have to list all 6 in one TBM.
  • Table begins with #Start
  • Table uses rigid system in the order of the entries:
  • Fireball.tbl has 6 entries with a specific function and every one is required and must be listed in the following order.
  • xxx-fbl.tbm doesn't need to have the entries listed in specific order, see fireball identifier.
  • Order of the entries in fireball.tbl:
    • Medium sized explosion
    • Normal warp effect
    • Knossos warp effect
    • Asteroid explosion
    • Large explosion 1
    • Large explosion 2
  • Table ends to #End


$Name:

  • Defines the name of the animation used for the particular fireball effect
    • Syntax: String, filename


Fireball identifier

FS2 Open, 3.6.x:
  • Identifies the assigned animation with one of the fireball types.
    • Syntax: String, name of the identifier
    • Allowed identifiers:
+Explosion_Medium
+Warp_Effect
+Knossos_Effect
+Asteroid
+Explosion_Large1
+Explosion_Large2


$LOD:

  • Optional $LOD: entry exists to specify a lod count, at least 1 is assumed if not specified.
    • Syntax: Integer


$Light Color:

FS2 Open, 3.6.x:
  • Defines the color that is given off when that fireball effect is created.
    • Syntax: Color, three integers, 0 to 255, red, green, blue respectively


Default colors

FS2 Open, 3.6.x:
  • Large explosion 1, large explosion 1, medium sized explosion, and asteroid explosion
    • 255, 127, 31
  • Normal warp effect
    • 191, 191, 255
  • Knossos warp effect
    • 191, 255, 191


Sample Entries

  • fireball.tbl
#Start
$Name:   exp04
   $LOD:    1
$Name:   WarpMap01
   $LOD:    4
$Name:   WarpMap02
   $LOD:    4
$Name:   exp05
   $LOD:    4
$Name:   exp05
   $LOD:    4
$Name:   exp06
   $LOD:    4
#End


FS2 Open, 3.6.x:

xxx-fbl.tbm 

#Start
$Name:   exp06
   +Asteroid
$LOD:    4
#End
Retrieved from "https://wiki.hard-light.net/index.php?title=Fireball.tbl&oldid=11032"