Difference between revisions of "Fireball.tbl"

From FreeSpace Wiki
Jump to: navigation, search
m (added the light color)
(Table Fields: Mention that "$Unique ID:" can be used to reference the fireball for an SSM strike warp effect.)
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{TableVersionGit|2018-09-20|5206aaa}}
 +
 +
The '''fireball.tbl''' is used to define the usage of animations with certain special effects in game.
 +
 +
 +
This table is one of the [[Modular Tables]] and can be extended with xxx-fbl.tbm.
 +
 +
[[Tables|List of Tables]]
 +
 
==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 is used for specifying which filenames are to be used for which explosions
*'''#Start'''
+
*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'''
+
*Order of the entries in fireball.tbl:
***'''Normal warp effect'''
+
**'''Medium sized explosion'''
***'''Knossos warp effect'''
+
**'''Normal warp effect'''
***'''Asteroid explosion'''
+
**'''Knossos warp effect'''
***'''Large explosion 1'''
+
**'''Asteroid explosion'''
***'''Large explosion 2'''
+
**'''Large explosion 1'''
***An optional '''$LOD:''' entry exists to specify a lod count, at least 1 is assumed if not specified.
+
**'''Large explosion 2'''
****Syntax: ''Value''
+
*Any entries defined after the first 6 is considered a custom fireball and will not be used in the game unless specified as an explosion for a ship type or ship class in ships.tbl or objecttypes.tbl, or a custom warp effect in the warp-effect sexp.
***Optional '''$Light Color:''' entry is used to set the color that is given off when that explosion is created.
+
*Table ends with '''#End'''
****Syntax: ''Value'', ''Value'', ''Value'' (RGB value, 0 to 255)
+
*The modular version of the fireball table can only replace existing entries in fireball.tbl. No entries can be created in a modular table for fireball.tbl
*'''#End'''
+
{{Table381|
 +
*As of 3.8.2, the internal code to handle modular fireball.tbl entries has been rewritten, and it is now possible to add entries in a modular table.
 +
}}
 +
*All entries defined in a modular table for fireball.tbl require a '''$Name:''' token before specifying the bitmap filename. A fireball identifier must also be defined in order to specify which individual entry in fireball.tbl that will be replaced, see [[fireball.tbl#Fireball_identifier|fireball identifier]].
 +
*The modular table entries can be in arbitrary order and can be placed in separate modular tables.
 +
 
 +
==Table Fields==
 +
{{Table381|
 +
===$Unique ID:===
 +
*Defines a string that can be used as a reference for this fireball entry.  In most tables, $Name performs this role, but fireball.tbl allows multiple fireball entries which use the same animation.  The unique ID can be used to override fireball entries in a modular table, or to reference a fireball in the <tt>warp-effect</tt> and <tt>explosion-effect</tt> SEXPs, or as the warp effect of an [[Ssm.tbl#+WarpEffect:|SSM strike]].
 +
 
 +
*If this field is not present, the game will generate a unique ID for the entry automatically.
 +
**Syntax: '''String'''
 +
}}
 +
===$Name:===
 +
*Defines the name of the animation used for the particular fireball effect
 +
**Syntax: '''String''', filename
 +
 
 +
===Fireball identifier===
 +
{{Table3610|
 +
*Identifies the assigned animation with one of the fireball types. Only used in '''xxx-fbl.tbm'''
 +
**Syntax: '''String''', name of the identifier
 +
**Allowed identifiers:
 +
:::'''+Explosion_Medium'''
 +
:::'''+Warp_Effect'''
 +
:::'''+Knossos_Effect'''
 +
:::'''+Asteroid'''
 +
:::'''+Explosion_Large1'''
 +
:::'''+Explosion_Large2'''
 +
:::'''+Custom_Fireball 6'''
 +
:::'''+Custom_Fireball 7'''
 +
:::'''+Custom_Fireball (...)'''}}
 +
{{Table381|
 +
*In 3.8.2, this is not required; $Unique ID can be used as an alternative.  If neither the identifier nor $Unique ID is present, the entry is assumed to be a new custom fireball.
 +
}}
 +
 
 +
===$LOD:===
 +
*Optional '''$LOD:''' entry exists to specify a lod count, at least 1 is assumed if not specified.
 +
**Syntax: '''Integer'''
 +
 
 +
===$Light Color:===
 +
{{Table3610|
 +
*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===
+
====Default colors====
 +
{{Table3610|
 
*''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 75:
 
**191, 191, 255
 
**191, 191, 255
 
*''Knossos warp effect''
 
*''Knossos warp effect''
**191, 255, 191
+
**191, 255, 191}}
  
==Sample Entry==
+
{{Table381|
 +
===$Warp glow:===
 +
*Defines the warp glow bitmap used if this fireball is a warp effect.  By default, <tt>warpglow01</tt> is internally assigned to ''both'' the '''Warp Effect''' and '''Knossos Effect''' entries, but both the tbl and tbm can override this.  Retail <tt>sparky_fs2.vp</tt> supplies a <tt>warpglow02</tt> bitmap for the Knossos effect, but the game never actually uses it.
 +
**Syntax: '''String'''
 +
}}
  
  #Start
+
{{Table381|
  $Name:   exp04
+
===$Warp ball:===
      $LOD:    1
+
*Defines the "warp ball" bitmap used if this fireball is a warp effect.  By default, <tt>warpball01</tt> is internally assigned to ''both'' the '''Warp Effect''' and '''Knossos Effect''' entries, but both the tbl and tbm can override this.  The "warp ball" bitmap is only used for the "flash on warp" command-line option.
  $Name:  WarpMap01
+
**Syntax: '''String'''
      $LOD:    4
+
}}
  $Name:  WarpMap02
 
      $LOD:    4
 
  $Name:  exp05
 
      $LOD:    4
 
  $Name:  exp05
 
      $LOD:    4
 
  $Name:  exp06
 
      $LOD:   4
 
  #End
 
  
<font color=red>
+
{{Table381|
==Modular Fireball Table==
+
===$Warp model:===
*'''''xxx-fbl.tbm'''''
+
*Defines the warp model file used if this fireball is a warp effectBy default, <tt>warp.pof</tt> is internally assigned to ''both'' the '''Warp Effect''' and '''Knossos Effect''' entries, but both the tbl and tbm can override this.  The warp model is used for the "3D warp" command-line option, or for the <tt>warp-effect</tt> SEXP when a 3D warp is specified.
*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 TBMsNo 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.
+
**Syntax: '''String'''
**'''+Explosion_Medium'''
+
}}
***Specified name and LOD count will be used for the medium explosion effect
 
**'''+Warp_Effect'''
 
***Specified name and LOD count used for the normal warp effect
 
**'''+Knossos_Effect'''
 
***Specified name and LOD count for the knossos/special warp effect
 
**'''+Asteroid'''
 
***Specifiedname and LOD count for asteroid explosions
 
**'''+Explosion_Large1'''
 
***Specified name and LOD count for the 1st of the large explosions
 
**'''+Explosion_Large2'''
 
***Specified name and LOD count for the 2nd of the large explosions
 
  
==Sample Entry==
+
==Sample Entries==
  
  #Start
+
*'''fireball.tbl'''
   $Name:  exp06
+
<pre>
      +Asteroid
+
#Start
 +
$Name:  exp04
 +
  $LOD:   1
 +
$Name:  WarpMap01
 
   $LOD:    4
 
   $LOD:    4
   #End
+
$Name:  WarpMap02
</font>
+
  $LOD:    4
 +
$Name:  exp05
 +
  $LOD:    4
 +
$Name:  exp05
 +
  $LOD:    4
 +
$Name:  exp06
 +
  $LOD:    4
 +
#End
 +
</pre>
 +
 
 +
 
 +
{{Table3610|
 +
 
 +
'''fireball.tbl'''
 +
<pre>
 +
; This is an example of a table that defines the the default 6 fireball
 +
; bitmaps (Fireballs 0 through 5) while adding extra custom fireballs as well.
 +
#Start
 +
$Name: exp04 ;0 Used for the 4 little explosions before a ship explodes
 +
$LOD: 1
 +
$Name: WarpMap01 ;1 Used for the warp in / warp out effect
 +
$LOD: 4
 +
$Name: WarpMap02 ;2 Used for the KNOSSOS warp in / warp out effect
 +
$LOD: 4
 +
$Name: exp05 ;3 Used when an asteroid explodes
 +
$LOD: 4
 +
$Name: exp05 ;4 ship explosion 1
 +
$LOD: 4
 +
$Name: exp06 ;5 ship explosion 2
 +
$LOD: 4
 +
$Name: capship_boom ;6 First custom fireball. Identified as +Custom_Fireball 6
 +
$LOD: 1
 +
$Name: debris_dust_cloud ;7 Second custom fireball. Identified as +Custom_Fireball 7
 +
$LOD: 1
 +
$Name: corvette_exp ;8 Third custom fireball. Identified as +Custom_Fireball 8
 +
$LOD: 1
 +
$Name: fenris_exp ;9 Fourth custom fireball. Identified as +Custom_Fireball 9
 +
$LOD: 1
 +
#End
 +
</pre>
 +
 
 +
'''xxx-fbl.tbm'''
 +
<pre>
 +
; This modular table replaces the entries in the sample fireball.tbl printed above
 +
#Start
 +
$Name:  exp06
 +
  +Asteroid
 +
$LOD:   4
 +
$Name:  fighter_explosion
 +
  +Custom_Fireball 7
 +
$LOD:    4
 +
$Name:  capship_explosion
 +
  +Custom_Fireball 6
 +
$LOD:    1
 +
$Name:  big_exp
 +
  +Explosion_Large1         
 +
$LOD:    1
 +
$Name:  capship_explosion1
 +
  +Custom_Fireball 8
 +
$LOD:    1
 +
$Name:  capship_explosion2
 +
  +Custom_Fireball 9
 +
$LOD:    1
 +
#End
 +
</pre>
 +
}}
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 22:46, 14 April 2019

Revision information.....

FSO Git Commit: Date: 2018-09-20 SHA: 5206aaa
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 fireball.tbl is used to define the usage of animations with certain special effects in game.


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

List of Tables

General Format

  • Fireball.tbl table file is used for specifying which filenames are to be used for which explosions
  • 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.
  • Order of the entries in fireball.tbl:
    • Medium sized explosion
    • Normal warp effect
    • Knossos warp effect
    • Asteroid explosion
    • Large explosion 1
    • Large explosion 2
  • Any entries defined after the first 6 is considered a custom fireball and will not be used in the game unless specified as an explosion for a ship type or ship class in ships.tbl or objecttypes.tbl, or a custom warp effect in the warp-effect sexp.
  • Table ends with #End
  • The modular version of the fireball table can only replace existing entries in fireball.tbl. No entries can be created in a modular table for fireball.tbl
FS2 Open, 19.0:
  • As of 3.8.2, the internal code to handle modular fireball.tbl entries has been rewritten, and it is now possible to add entries in a modular table.
  • All entries defined in a modular table for fireball.tbl require a $Name: token before specifying the bitmap filename. A fireball identifier must also be defined in order to specify which individual entry in fireball.tbl that will be replaced, see fireball identifier.
  • The modular table entries can be in arbitrary order and can be placed in separate modular tables.

Table Fields

FS2 Open, 19.0:

$Unique ID:

  • Defines a string that can be used as a reference for this fireball entry. In most tables, $Name performs this role, but fireball.tbl allows multiple fireball entries which use the same animation. The unique ID can be used to override fireball entries in a modular table, or to reference a fireball in the warp-effect and explosion-effect SEXPs, or as the warp effect of an SSM strike.
  • If this field is not present, the game will generate a unique ID for the entry automatically.
    • Syntax: String

$Name:

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

Fireball identifier

FS2 Open 3.6.10:
  • Identifies the assigned animation with one of the fireball types. Only used in xxx-fbl.tbm
    • Syntax: String, name of the identifier
    • Allowed identifiers:
+Explosion_Medium
+Warp_Effect
+Knossos_Effect
+Asteroid
+Explosion_Large1
+Explosion_Large2
+Custom_Fireball 6
+Custom_Fireball 7
+Custom_Fireball (...)
FS2 Open, 19.0:
  • In 3.8.2, this is not required; $Unique ID can be used as an alternative. If neither the identifier nor $Unique ID is present, the entry is assumed to be a new custom fireball.

$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.10:
  • 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.10:
  • 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


FS2 Open, 19.0:

$Warp glow:

  • Defines the warp glow bitmap used if this fireball is a warp effect. By default, warpglow01 is internally assigned to both the Warp Effect and Knossos Effect entries, but both the tbl and tbm can override this. Retail sparky_fs2.vp supplies a warpglow02 bitmap for the Knossos effect, but the game never actually uses it.
    • Syntax: String


FS2 Open, 19.0:

$Warp ball:

  • Defines the "warp ball" bitmap used if this fireball is a warp effect. By default, warpball01 is internally assigned to both the Warp Effect and Knossos Effect entries, but both the tbl and tbm can override this. The "warp ball" bitmap is only used for the "flash on warp" command-line option.
    • Syntax: String


FS2 Open, 19.0:

$Warp model:

  • Defines the warp model file used if this fireball is a warp effect. By default, warp.pof is internally assigned to both the Warp Effect and Knossos Effect entries, but both the tbl and tbm can override this. The warp model is used for the "3D warp" command-line option, or for the warp-effect SEXP when a 3D warp is specified.
    • Syntax: String

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.10:

fireball.tbl

; This is an example of a table that defines the the default 6 fireball 
; bitmaps (Fireballs 0 through 5) while adding extra custom fireballs as well.
#Start
$Name:	exp04				;0 Used for the 4 little explosions before a ship explodes
$LOD:		1
$Name:	WarpMap01			;1 Used for the warp in / warp out effect
$LOD:		4
$Name:	WarpMap02			;2 Used for the KNOSSOS warp in / warp out effect
$LOD:		4
$Name:	exp05				;3 Used when an asteroid explodes
$LOD:		4
$Name:	exp05				;4 ship explosion 1
$LOD:		4
$Name:	exp06				;5 ship explosion 2
$LOD:		4
$Name:	capship_boom			;6 First custom fireball. Identified as +Custom_Fireball 6 
$LOD:		1
$Name:	debris_dust_cloud		;7 Second custom fireball. Identified as +Custom_Fireball 7
$LOD:		1
$Name:	corvette_exp			;8 Third custom fireball. Identified as +Custom_Fireball 8
$LOD:		1
$Name:	fenris_exp			;9 Fourth custom fireball. Identified as +Custom_Fireball 9
$LOD: 	1
#End

xxx-fbl.tbm

; This modular table replaces the entries in the sample fireball.tbl printed above
#Start
$Name:   exp06
   +Asteroid
$LOD:    4
$Name:   fighter_explosion
   +Custom_Fireball 7
$LOD:    4
$Name:   capship_explosion
   +Custom_Fireball 6
$LOD:    1
$Name:   big_exp
   +Explosion_Large1          
$LOD:    1
$Name:   capship_explosion1
   +Custom_Fireball 8
$LOD:    1
$Name:   capship_explosion2
   +Custom_Fireball 9
$LOD:    1
#End