Fireball.tbl - Revision history

Androgeos Exeunt: Replaced link to list of tables with actual list on the right.

2020-10-13T04:27:49Z

Replaced link to list of tables with actual list on the right.

← Older revision		Revision as of 04:27, 13 October 2020
Line 1:		Line 1:
	{{TableVersionGit\|2018-09-20\|5206aaa}}		{{TableVersionGit\|2018-09-20\|5206aaa}}
			{{Tables}}
	The '''fireball.tbl''' is used to define the usage of animations with certain special effects in game.		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.		This table is one of the [[Modular Tables]] and can be extended with xxx-fbl.tbm.

	~~[[Tables\|List of Tables]]~~

	==General Format==		==General Format==

AdmiralRalwood: /* Table Fields */ Mention that "$Unique ID:" can be used to reference the fireball for an SSM strike warp effect.

2019-04-14T22:46:11Z

Table Fields: Mention that "$Unique ID:" can be used to reference the fireball for an SSM strike warp effect.

← Older revision		Revision as of 22:46, 14 April 2019
Line 32:		Line 32:
	{{Table381\|		{{Table381\|
	===$Unique ID:===		===$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.		*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.		*If this field is not present, the game will generate a unique ID for the entry automatically.
Line 94:		Line 94:
	**Syntax: '''String'''		**Syntax: '''String'''
	}}		}}


	==Sample Entries==		==Sample Entries==

Goober5000: add new fireball.tbl features

2018-09-21T03:37:38Z

add new fireball.tbl features

← Older revision		Revision as of 03:37, 21 September 2018
Line 1:		Line 1:
	{{~~TableVersion~~\|~~4879~~}}		{{TableVersionGit\|2018-09-20\|5206aaa}}

	The '''fireball.tbl''' is used to define the usage of animations with certain special effects in game.		The '''fireball.tbl''' is used to define the usage of animations with certain special effects in game.
Line 20:		Line 20:
	**'''Large explosion 1'''		**'''Large explosion 1'''
	**'''Large explosion 2'''		**'''Large explosion 2'''
	*Any entries defined after the first 6 is considered a custom fireball and will not be used in the game ~~until~~ specified as an explosion for a ship type or ship class in ships.tbl or objecttypes.tbl.		*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'''		*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		*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
			{{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]].		*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.		*The modular table entries can be in arbitrary order and can be placed in separate modular tables.

	==Table Fields==		==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.

			*If this field is not present, the game will generate a unique ID for the entry automatically.
			**Syntax: '''String'''
			}}
	===$Name:===		===$Name:===
	*Defines the name of the animation used for the particular fireball effect		*Defines the name of the animation used for the particular fireball effect
Line 45:		Line 55:
	:::'''+Custom_Fireball 7'''		:::'''+Custom_Fireball 7'''
	:::'''+Custom_Fireball (...)'''}}		:::'''+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:===		===$LOD:===
Line 63:		Line 76:
	*''Knossos warp effect''		*''Knossos warp effect''
	**191, 255, 191}}		**191, 255, 191}}

			{{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'''
			}}

			{{Table381\|
			===$Warp ball:===
			*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.
			**Syntax: '''String'''
			}}

			{{Table381\|
			===$Warp model:===
			*Defines the warp model file used if this fireball is a warp effect. By 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.
			**Syntax: '''String'''
			}}

MjnMixael at 00:34, 20 July 2012

2012-07-20T00:34:06Z

← Older revision		Revision as of 00:34, 20 July 2012
Line 4:		Line 4:


	This table is one of the [[Modular Tables]] and can be extended with xxx-fbl.tbm~~, however it is a special case. See below~~.		This table is one of the [[Modular Tables]] and can be extended with xxx-fbl.tbm.

	[[Tables\|List of Tables]]		[[Tables\|List of Tables]]

MjnMixael: formatting

2012-07-19T03:59:01Z

formatting

← Older revision		Revision as of 03:59, 19 July 2012
Line 1:		Line 1:
	{{TableVersion\|4879}}		{{TableVersion\|4879}}

	~~This table~~ is used to define the usage of animations with certain special effects in game.		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, however it is a special case. See below.		This table is one of the [[Modular Tables]] and can be extended with xxx-fbl.tbm, however it is a special case. See below.

			[[Tables\|List of Tables]]

	==General Format==		==General Format==

MjnMixael at 17:47, 24 March 2012

2012-03-24T17:47:00Z

← Older revision		Revision as of 17:47, 24 March 2012
Line 2:		Line 2:

	This table is used to define the usage of animations with certain special effects in game.		This table 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, however it is a special case. See below.

	==General Format==		==General Format==

MjnMixael: Revision fix

2011-12-13T17:10:03Z

Revision fix

← Older revision		Revision as of 17:10, 13 December 2011
Line 1:		Line 1:
	{{TableVersion~~\|4879~~\|4879}}		{{TableVersion\|4879}}

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

Wanderer: updated version info

2009-06-14T15:10:52Z

updated version info

← Older revision		Revision as of 15:10, 14 June 2009
Line 1:		Line 1:
	~~Revision information.. <!-- Please update this information when page is updated -->~~		{{TableVersion\|4879\|4879}}
	~~::'''3.6.x branch:''' 2.33.2.4~~
	~~::'''3.7 branch:''' 2.38~~


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

	===Fireball identifier===		===Fireball identifier===
	{{~~Table36~~\|		{{Table3610\|
	*Identifies the assigned animation with one of the fireball types. Only used in '''xxx-fbl.tbm'''		*Identifies the assigned animation with one of the fireball types. Only used in '''xxx-fbl.tbm'''
	**Syntax: '''String''', name of the identifier		**Syntax: '''String''', name of the identifier
Line 49:		Line 46:

	===$Light Color:===		===$Light Color:===
	{{~~Table36~~\|		{{Table3610\|
	*Defines the color that is given off when that fireball effect is created.		*Defines the color that is given off when that fireball effect is created.
	**Syntax: '''Color''', three '''integers''', 0 to 255, red, green, blue respectively}}		**Syntax: '''Color''', three '''integers''', 0 to 255, red, green, blue respectively}}

	====Default colors====		====Default colors====
	{{~~Table36~~\|		{{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 84:		Line 81:


	{{~~Table36~~\|		{{Table3610\|

	'''fireball.tbl'''		'''fireball.tbl'''

Swifty: Updated to reflect the new fireball.tbl format introduced in 3.6.10

2009-03-31T00:31:58Z

Updated to reflect the new fireball.tbl format introduced in 3.6.10

← Older revision		Revision as of 00:31, 31 March 2009
Line 1:		Line 1:
	Revision information.. <!-- Please update this information when page is updated -->		Revision information.. <!-- Please update this information when page is updated -->
	::'''3.6.x branch:''' 2.33.2.4		::'''3.6.x branch:''' 2.33.2.4
	::'''3.7 branch:''' 2.38		::'''3.7 branch:''' 2.38


Line 7:		Line 7:

	==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
	*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 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.
	*'''''xxx-fbl.tbm''''' doesn't need to have the entries listed in specific order, see [[fireball.tbl#Fireball_identifier\|fireball identifier]].
	*Order of the entries in fireball.tbl:		*Order of the entries in fireball.tbl:
	**'''Medium sized explosion'''		**'''Medium sized explosion'''
Line 20:		Line 18:
	**'''Large explosion 1'''		**'''Large explosion 1'''
	**'''Large explosion 2'''		**'''Large explosion 2'''
	*Table ends to '''#End'''		*Any entries defined after the first 6 is considered a custom fireball and will not be used in the game until specified as an explosion for a ship type or ship class in ships.tbl or objecttypes.tbl.
			*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
			*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==
	===$Name:===		===$Name:===
	*Defines the name of the animation used for the particular fireball effect		*Defines the name of the animation used for the particular fireball effect
	**Syntax: '''String''', filename		**Syntax: '''String''', filename


	===Fireball identifier===		===Fireball identifier===
	{{Table36\|		{{Table36\|
	*Identifies the assigned animation with one of the fireball types.		*Identifies the assigned animation with one of the fireball types. Only used in '''xxx-fbl.tbm'''
	**Syntax: '''String''', name of the identifier		**Syntax: '''String''', name of the identifier
	**Allowed identifiers:		**Allowed identifiers:
Line 38:		Line 39:
	:::'''+Asteroid'''		:::'''+Asteroid'''
	:::'''+Explosion_Large1'''		:::'''+Explosion_Large1'''
	:::'''+Explosion_Large2'''}}		:::'''+Explosion_Large2'''
			:::'''+Custom_Fireball 6'''
			:::'''+Custom_Fireball 7'''
			:::'''+Custom_Fireball (...)'''}}

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


	===$Light Color:===		===$Light Color:===
Line 50:		Line 52:
	*Defines the color that is given off when that fireball effect is created.		*Defines the color that is given off when that fireball effect is created.
	**Syntax: '''Color''', three '''integers''', 0 to 255, red, green, blue respectively}}		**Syntax: '''Color''', three '''integers''', 0 to 255, red, green, blue respectively}}


	====Default colors====		====Default colors====
Line 84:		Line 85:

	{{Table36\|		{{Table36\|

			'''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'''		'''xxx-fbl.tbm'''
	<pre>		<pre>
			; This modular table replaces the entries in the sample fireball.tbl printed above
	#Start		#Start
	$Name: exp06		$Name: exp06
	+Asteroid		+Asteroid
	$LOD: 4		$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		#End
	</pre>}}		</pre>
			}}

	[[Category:Tables]]		[[Category:Tables]]

Wanderer: updated version info

2007-11-21T19:05:33Z

updated version info

← Older revision		Revision as of 19:05, 21 November 2007
Line 1:		Line 1:
	Revision information.. <!-- Please update this information when page is updated -->		Revision information.. <!-- Please update this information when page is updated -->
	::'''3.6.x branch:''' 2.33.2.3		::'''3.6.x branch:''' 2.33.2.4
	::'''3.7 branch:''' 2.37		::'''3.7 branch:''' 2.38