TFE Projectile Data - Revision history

Jerethk: /* Mods */

2024-11-30T07:13:14Z

Mods

← Older revision		Revision as of 00:13, 30 November 2024
Line 8:		Line 8:
	A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the base version.		A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the base version.

	Modded versions of <code>projectiles.json</code> need to include definitions for all 19 of the Dark Forces projectiles. If any projectile definitions are missing, those projectiles will not work.		Modded versions of <code>projectiles.json</code> need to include definitions for all 19 of the Dark Forces projectiles. If any projectile definitions are missing, those projectiles will not work when the game is played.

	=== Projectile properties ===		=== Projectile properties ===

Jerethk: /* Projectile properties */

2024-11-30T07:10:06Z

Projectile properties

← Older revision		Revision as of 00:10, 30 November 2024
Line 12:		Line 12:
	=== Projectile properties ===		=== Projectile properties ===
	Each projectile type can have the following properties defined. This table lists the properties and what they mean.		Each projectile type can have the following properties defined. This table lists the properties and what they mean.

			If a property is not defined in the JSON, it will fall back to the default shown in the table.

	{\| border=1 cellpadding=6px		{\| border=1 cellpadding=6px

Jerethk at 07:09, 30 November 2024

2024-11-30T07:09:10Z

← Older revision		Revision as of 00:09, 30 November 2024
Line 3:		Line 3:
	Altering the data in <code>projectiles.json</code> will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loading the game.)		Altering the data in <code>projectiles.json</code> will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loading the game.)

	Note that all text in the JSON is case insensitive (uppercase, lowercase or a mixture may be used).		Note that all text in the JSON is case insensitive (uppercase, lowercase or a mixture may be used). The projectiles and their properties can be listed in any order.

	=== Mods ===		=== Mods ===

Jerethk at 07:07, 30 November 2024

2024-11-30T07:07:28Z

← Older revision		Revision as of 00:07, 30 November 2024
Line 7:		Line 7:
	=== Mods ===		=== Mods ===
	A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the base version.		A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the base version.

			Modded versions of <code>projectiles.json</code> need to include definitions for all 19 of the Dark Forces projectiles. If any projectile definitions are missing, those projectiles will not work.

	=== Projectile properties ===		=== Projectile properties ===

Jerethk: /* Projectile properties */

2024-11-23T14:25:00Z

Projectile properties

@@ Line 33: / Line 33: @@
 * <code>homing</code> - A homing projectile.
 |-
-| damage || number (integer) || 0 || Maximum damage caused by the projectile (equivalent to hitpoints). The projectile will cause this amount of damage before any falloff occurs.
+| damage || number (integer) || 0 || Maximum damage caused by the projectile (equivalent to hitpoints). The projectile will cause this amount of damage before any falloff occurs. Note that some projectiles are set to zero damage because damage is inflicted by their explosions rather than by the projectile itself.
 |-
 | falloffAmount || number (decimal) || 0 || Damage falloff amount
@@ Line 52: / Line 52: @@
 |-
 | bounceCount || number (integer) || 0 || Number of times that a projectile can bounce or reflect off a surface. If set to a positive value, the projectile will only bounce in a sector with the "magseal" flag set. If set to 0, the projectile will never bounce; it will explode on first impact. If set to -1, the projectile can bounce an infinite number of times until its time expires, and it will bounce in any sector (whether magseal or not).  BounceCount is set to -1 for thermal detonators.
+|-
 |}

Jerethk: /* Projectile properties */

2024-11-23T13:57:09Z

Projectile properties

← Older revision		Revision as of 06:57, 23 November 2024
Line 23:		Line 23:
	\| zeroWidth \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will not have a collision radius. Most projectiles have zero width.		\| zeroWidth \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will not have a collision radius. Most projectiles have zero width.
	\|-		\|-
	\| autoAim \|\| boolean \|\| <code>false</code> \|\| If true, the player's weapons will auto-aim at the projectile. (This applies to Mohc's homing missiles because they can be shot down.		\| autoAim \|\| boolean \|\| <code>false</code> \|\| If true, the player's weapons will auto-aim at the projectile. (This applies to Mohc's homing missiles because they can be shot down.)
	\|-		\|-
	\| movable \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will be moved by elevators. For example if you lay a mine on a rotating sector, the mine will rotate with it.		\| movable \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will be moved by elevators. For example if you lay a mine on a rotating sector, the mine will rotate with it.
Line 43:		Line 43:
	\| minDamage \|\| number (integer) \|\| 0 \|\| Minimum damage caused by the projectile. Once the damage has fallen off to this value, no further falloff will occur.		\| minDamage \|\| number (integer) \|\| 0 \|\| Minimum damage caused by the projectile. Once the damage has fallen off to this value, no further falloff will occur.
	\|-		\|-
	\|		\| force \|\| number (decimal) \|\| 0 \|\| How much the projectile will "push" an object on impact. Is multiplied by the projectile's speed.
			\|-
			\| speed \|\| number (integer) \|\| 0 \|\| The initial speed of the projectile. DFU per second.
			\|-
			\| horzBounciness \|\| number (decimal) \|\| 0 \|\| Defines how much of the projectile's speed is retained after it bounces off a wall. A bounciness of 1.0 means that the projectile will maintain the same speed after bouncing; numbers less than 1.0 mean that the projectile will lose speed. (Setting bounciness to a value greater than 1.0 will cause the projectile to ''gain'' speed when bouncing!) Bounciness is only calculated when bounceCount is -1 (in practice, this means that it is only used for Thermal detonators).
			\|-
			\| vertBounciness \|\| number (decimal) \|\| 0 \|\| Defines how much of the projectile's speed is retained after it bounces off a ceiling or floor. See above.
			\|-
			\| bounceCount \|\| number (integer) \|\| 0 \|\| Number of times that a projectile can bounce or reflect off a surface. If set to a positive value, the projectile will only bounce in a sector with the "magseal" flag set. If set to 0, the projectile will never bounce; it will explode on first impact. If set to -1, the projectile can bounce an infinite number of times until its time expires, and it will bounce in any sector (whether magseal or not). BounceCount is set to -1 for thermal detonators.

	\|}		\|}

Jerethk at 12:42, 23 November 2024

2024-11-23T12:42:10Z

@@ Line 2: / Line 2: @@
 Altering the data in <code>projectiles.json</code> will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loading the game.)
 === Mods ===
@@ Line 24: / Line 26: @@
 |-
 | movable || boolean || <code>false</code> || If true, the projectile will be moved by elevators. For example if you lay a mine on a rotating sector, the mine will rotate with it.
 |}

Jerethk at 12:26, 23 November 2024

2024-11-23T12:26:21Z

← Older revision		Revision as of 05:26, 23 November 2024
Line 4:		Line 4:

	=== Mods ===		=== Mods ===
	A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the ~~original~~.		A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the base version.

			=== Projectile properties ===
			Each projectile type can have the following properties defined. This table lists the properties and what they mean.

			{\| border=1 cellpadding=6px
			\|-
			! Property !! Type !! Default value !! Description
			\|-
			\| assetType \|\| string \|\| <code>"spirit"</code> \|\| The type of asset that the projectile uses. It must be one of the following: "spirit", "frame", "sprite" or "3d". (A spirit is an invisible object that has no asset.)
			\|-
			\| asset \|\| string \|\| \|\| A <code>.FME</code>, <code>.WAX</code>, or <code>.3DO</code> file. The type must match the assetType. If the assetType is <code>spirit</code>, this property can be left unset and will be ignored.
			\|-
			\| fullBright \|\| boolean \|\| <code>false</code> \|\| Whether or not the asset will be rendered fullbright.
			\|-
			\| zeroWidth \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will not have a collision radius. Most projectiles have zero width.
			\|-
			\| autoAim \|\| boolean \|\| <code>false</code> \|\| If true, the player's weapons will auto-aim at the projectile. (This applies to Mohc's homing missiles because they can be shot down.
			\|-
			\| movable \|\| boolean \|\| <code>false</code> \|\| If true, the projectile will be moved by elevators. For example if you lay a mine on a rotating sector, the mine will rotate with it.
			\|}

Jerethk: Created page with "Projectile data is hardcoded in Dark Forces but the data has been externalised to a JSON file in '''The Force Engine'''. The data is located in `ExternalData\DarkForces\projectiles.json`. Altering the data in `projectiles.json` will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loadin..."

2024-11-23T12:04:50Z

Created page with "Projectile data is hardcoded in Dark Forces but the data has been externalised to a JSON file in '''The Force Engine'''. The data is located in <code>ExternalData\DarkForces\projectiles.json</code>. Altering the data in <code>projectiles.json</code> will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loadin..."

New page

Projectile data is hardcoded in Dark Forces but the data has been externalised to a JSON file in '''The Force Engine'''. The data is located in <code>ExternalData\DarkForces\projectiles.json</code>.

Altering the data in <code>projectiles.json</code> will alter the way that weapon projectiles behave in the game. If the JSON file is removed, renamed or corrupted, weapons will not work correctly. (In this case, an error message will be logged to the TFE console when loading the game.)

=== Mods ===
A customised version of <code>projectiles.json</code> can be included in a mod's ZIP file. A modded <code>projectiles.json</code> will take precedence over the original.