TFE Weapon Data - Revision history

Jerethk: /* Animation frames */

2025-02-18T13:38:39Z

Animation frames

← Older revision		Revision as of 06:38, 18 February 2025
Line 75:		Line 75:
	* Assault cannon secondary		* Assault cannon secondary
	\|		\|
	The frames will cycle through in order with each shot fired. The final frame needs to be the weapon's "~~resting~~" (non-firing) texture, i.e. texture 0. Additional frames can be inserted into the cycle.		The frames will cycle through in order with each shot fired. The final frame needs to be the weapon's "idle" (non-firing) texture, i.e. texture 0. Additional frames can be inserted into the cycle.
	\|-		\|-
	\|		\|
Line 81:		Line 81:
	* Assault cannon primary		* Assault cannon primary
	\|		\|
	The frames will cycle through in order with each shot fired. A "~~resting~~" frame does not need to be included; these weapons are hardcoded to return to their non-firing texture (texture 0) when they stop firing. Additional frames can be inserted into the cycle.		The frames will cycle through in order with each shot fired. An "idle" frame does not need to be included; these weapons are hardcoded to return to their non-firing texture (texture 0) when they stop firing. Additional frames can be inserted into the cycle.
	\|-		\|-
	\|		\|

Jerethk: /* Note about offsets */

2025-02-17T14:59:45Z

Note about offsets

← Older revision		Revision as of 07:59, 17 February 2025
Line 11:		Line 11:

	=== Note about offsets ===		=== Note about offsets ===
	xPos and yPos offsets are based on a screen with width 320 pixels and height 200 pixels.		xPos and yPos offsets are based on a screen with width 320 pixels and height 200 pixels, regardless of what resolution you have set in TFE.

	=== Gasmask ===		=== Gasmask ===

Jerethk: /* Animation frames */

2025-02-17T14:58:10Z

Animation frames

← Older revision		Revision as of 07:58, 17 February 2025
Line 58:		Line 58:
	==== Animation frames ====		==== Animation frames ====
	Each weapon has a list of animation frames that are played when the weapon fires. The repeater, fusion gun and assault cannon also have a list of animation frames for their secondary fire.		Each weapon has a list of animation frames that are played when the weapon fires. The repeater, fusion gun and assault cannon also have a list of animation frames for their secondary fire.

			Each animation frame references a texture by index (starting at 0).

	The way that animation frames are used depends on the weapon and type of fire.		The way that animation frames are used depends on the weapon and type of fire.
Line 113:		Line 115:
	\| durationNormal \|\| number (intger) \|\| Duration in ticks that this frame will display normally (no supercharge).		\| durationNormal \|\| number (intger) \|\| Duration in ticks that this frame will display normally (no supercharge).
	\|}		\|}

			Altering the durations (normal and supercharge) of each animation frame will alter the weapon's rate of fire. Smaller durations will result in more rapid fire. There are 145 ticks per second.

			If you are modding the weapons to insert additional animation frames (this is possible where indicated above), you will need to shorten the durations of the existing frames to preserve the original rate of fire.

Jerethk: /* Animation frames */

2025-02-17T14:47:43Z

Animation frames

@@ Line 73: / Line 73: @@
 * Assault cannon secondary
+|
-The frames will cycle through in order with each shot fired. The final frame is the weapon's "resting" (non-firing) texture. Additional frames can be inserted into the cycle.
+The frames will cycle through in order with each shot fired. The final frame needs to be the weapon's "resting" (non-firing) texture, i.e. texture 0. Additional frames can be inserted into the cycle.
 |}

Jerethk: Animation frames details

2025-02-17T14:03:03Z

Animation frames details

← Older revision		Revision as of 07:03, 17 February 2025
Line 33:		Line 33:
	\| frameCount \|\| number (integer) \|\| Number of animation textures. Maximum of 16.		\| frameCount \|\| number (integer) \|\| Number of animation textures. Maximum of 16.
	\|-		\|-
	\| textures \|\| array of string \|\| Textures that are used for the weapon's animation. Number of entries should match frameCount		\| textures \|\| array of string \|\| Textures that are used for the weapon's animation. Number of entries should match frameCount. These textures are referenced by the weapon's animation frames (see below for details)
	\|-		\|-
	\| xPos \|\| array of integers \|\| X offsets for each texture. Number of entries should match frameCount		\| xPos \|\| array of integers \|\| X offsets for each texture. Number of entries should match frameCount
Line 57:		Line 57:

	==== Animation frames ====		==== Animation frames ====
			Each weapon has a list of animation frames that are played when the weapon fires. The repeater, fusion gun and assault cannon also have a list of animation frames for their secondary fire.

			The way that animation frames are used depends on the weapon and type of fire.

			{\| border=1 cellpadding=6px
			\|-
			\|
			* Fists
			* Pistol
			* Rifle
			* Repeater secondary
			* Fusion secondary
			* Mortar
			* Concussion
			* Assault cannon secondary
			\|
			The frames will cycle through in order with each shot fired. The final frame is the weapon's "resting" (non-firing) texture. Additional frames can be inserted into the cycle.
			\|}

	Each animation frame contains the following 4 data items.		Each animation frame contains the following 4 data items.

Line 63:		Line 82:
	! Property !! Type !! Description		! Property !! Type !! Description
	\|-		\|-
	\| texture \|\| number (integer) \|\| Index into the weapon's array of textures. The first item in the array has index 0, the second item has index 1, and so on. A given texture can be referenced multiple times if desired.		\| texture \|\| number (integer) \|\| Index into the weapon's array of textures (see above). The first item in the array has index 0, the second item has index 1, and so on. A given texture can be referenced multiple times if desired.
	\|-		\|-
	\| light \|\| number (integer) \|\| Amount of extra light for this frame. This is used to create the "muzzle flash" effect when the weapon fires. A higher number gives a brighter flash.		\| light \|\| number (integer) \|\| Amount of extra light for this frame. This is used to create the "muzzle flash" effect when the weapon fires. A higher number gives a brighter flash.

Jerethk: /* Weapon data */ animation frames

2025-02-17T02:26:50Z

Weapon data: animation frames

← Older revision		Revision as of 19:26, 16 February 2025
Line 26:		Line 26:

	=== Weapon data ===		=== Weapon data ===

	{\| border=1 cellpadding=6px		{\| border=1 cellpadding=6px
	\|-		\|-
	! Property !! Type !! Description		! Property !! Type !! Description
	\|-		\|-
	\| frameCount \|\| number (integer) \|\| Number of animation textures		\| frameCount \|\| number (integer) \|\| Number of animation textures. Maximum of 16.
	\|-		\|-
	\| textures \|\| array of string \|\| ~~Texture names~~. Number of entries should match frameCount		\| textures \|\| array of string \|\| Textures that are used for the weapon's animation. Number of entries should match frameCount
	\|-		\|-
	\| xPos \|\| array of integers \|\| X offsets for each texture. Number of entries should match frameCount		\| xPos \|\| array of integers \|\| X offsets for each texture. Number of entries should match frameCount
Line 38:		Line 39:
	\| yPos \|\| array of integers \|\| Y offsets for each texture. Number of entries should match frameCount		\| yPos \|\| array of integers \|\| Y offsets for each texture. Number of entries should match frameCount
	\|-		\|-
	\| wakeupRange \|\| number (integer) \|\| Enemies within this range (in DF units) will be alerted when the weapon fires		\| wakeupRange \|\| number (integer) \|\| Enemies within this range (in DF units) will be alerted when the weapon fires. Setting this to zero has the effect of creating a "silent" weapon.
	\|-		\|-
	\| variation \|\| number (integer) \|\| Aim variability. A higher number will cause the weapon to "spray" more randomly; lower numbers give greater consistency of aim.		\| variation \|\| number (integer) \|\| Aim variability. A higher number will cause the weapon to "spray" more randomly; lower numbers give greater consistency of aim.
Line 49:		Line 50:
	\|-		\|-
	\| secondaryFireConsumption \|\| number (integer) \|\| Amount of ammo consumed per secondary fire shot.		\| secondaryFireConsumption \|\| number (integer) \|\| Amount of ammo consumed per secondary fire shot.
			\|-
			\| animFrames \|\| array of animation frames \|\| Animation frames for primary fire. See below for details.
			\|-
			\| animFramesSecondary \|\| array of animation frames \|\| Animation frames for secondary fire (repeater, fusion gun, assault cannon). See below for details.
			\|}

			==== Animation frames ====
			Each animation frame contains the following 4 data items.

			{\| border=1 cellpadding=6px
			\|-
			! Property !! Type !! Description
			\|-
			\| texture \|\| number (integer) \|\| Index into the weapon's array of textures. The first item in the array has index 0, the second item has index 1, and so on. A given texture can be referenced multiple times if desired.
			\|-
			\| light \|\| number (integer) \|\| Amount of extra light for this frame. This is used to create the "muzzle flash" effect when the weapon fires. A higher number gives a brighter flash.
			\|-
			\| durationSupercharge \|\| number (integer) \|\| Duration in ticks that this frame will display when the weapon supercharge powerup is active. (Typically this will be a shorter duration than normal.)
			\|-
			\| durationNormal \|\| number (intger) \|\| Duration in ticks that this frame will display normally (no supercharge).
	\|}		\|}

Jerethk at 12:36, 16 February 2025

2025-02-16T12:36:01Z

← Older revision		Revision as of 05:36, 16 February 2025
Line 40:		Line 40:
	\| wakeupRange \|\| number (integer) \|\| Enemies within this range (in DF units) will be alerted when the weapon fires		\| wakeupRange \|\| number (integer) \|\| Enemies within this range (in DF units) will be alerted when the weapon fires
	\|-		\|-
	\| variation \|\| number (integer) \|\| Aim variability. A higher number will cause the weapon to "spray" more; lower numbers give greater consistency of aim.		\| variation \|\| number (integer) \|\| Aim variability. A higher number will cause the weapon to "spray" more randomly; lower numbers give greater consistency of aim.
	\|-		\|-
	\| ammo \|\| string \|\| Type of main ammo used by the weapon. Options are <code>ammoEnergy</code>, <code>ammoPower</code>, <code>ammoDetonator</code>, <code>ammoShell</code>, <code>ammoMine</code>, <code>ammoPlasma</code>, <code>ammoMissile</code>		\| ammo \|\| string \|\| Type of main ammo used by the weapon. The count is shown as the large red numbers in the HUD. Options are <code>ammoEnergy</code>, <code>ammoPower</code>, <code>ammoDetonator</code>, <code>ammoShell</code>, <code>ammoMine</code>, <code>ammoPlasma</code>, <code>ammoMissile</code>
	\|-		\|-
	\| secondaryAmmo \|\| string \|\| Secondary ammo for the Assault Cannon. This ammo displays as the smaller green numbers on ~~the right~~ HUD.		\| secondaryAmmo \|\| string \|\| Secondary ammo for the Assault Cannon. Same options as above. This ammo count displays as the smaller green numbers on HUD.
			\|-
			\| primaryFireConsumption \|\| number (integer) \|\| Amount of ammo consumed per primary fire shot.
			\|-
			\| secondaryFireConsumption \|\| number (integer) \|\| Amount of ammo consumed per secondary fire shot.
	\|}		\|}

Jerethk at 12:19, 16 February 2025

2025-02-16T12:19:34Z

@@ Line 23: / Line 23: @@
 |-
 | yPos || Y (vertical) offset on the screen.
 |}

Jerethk: Start page

2025-02-16T12:01:11Z

Start page

New page

Weapon data has been externalised to a JSON file in '''The Force Engine'''. The data is located in <code>ExternalData\DarkForces\weapons.json</code>.

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

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

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

Modded versions of <code>weapons.json</code> need to include definitions for all 10 of the weapons plus the gasmask. If any weapon definitions are missing, they will not work when the game is played.

=== Note about offsets ===
xPos and yPos offsets are based on a screen with width 320 pixels and height 200 pixels.

=== Gasmask ===
The JSON also contains data for the gasmask.

{| border=1 cellpadding=6px
|-
| texture || The texture (BM) to use for the gasmask.
|-
| xPos || X (horizontal) offset on the screen.
|-
| yPos || Y (vertical) offset on the screen.
|}