TFE Pickup Data - Revision history

Jerethk: /* Pickup items and their properties */

2024-12-06T13:56:01Z

Pickup items and their properties

@@ Line 22: / Line 22: @@
 ! Property !! Type !! Default value !! Description
 |-
-| type || string || ''none'' || There are 7 types of pickup. These are:
+| type || string || ''none'' || There are 7 types of pickup; each type has a specific behaviour. These are:
 * <code>objective</code> - mission objective pickup (eg. Death Star Plans). Adds item to the inventory, triggers the <code>COMPLETE</code> elevator, and updates the objective screen in the PDA.
 * <code>weapon</code> - provides the player with an item (usually a weapon, but doesn't have to be) and ammo. Allows for two alternative messages depending on whether the player already has the item.
@@ Line 30: / Line 30: @@
 * <code>powerup</code> - used for the four powerups (supercharges, extra life, revive).
 * <code>special</code> - only used for Kyle's gear ("pile"). Restores all of the player's items on Jabship, and triggers the <code>COMPLETE</code> elevator.
 |}

Jerethk: /* Pickup item properties */

2024-12-06T13:23:48Z

Pickup item properties

← Older revision		Revision as of 06:23, 6 December 2024
Line 10:		Line 10:
	Modded versions of <code>pickups.json</code> need to include definitions for all 46 of the pickup items. If any pickup definitions are missing, those pickups will not work when the game is played.		Modded versions of <code>pickups.json</code> need to include definitions for all 46 of the pickup items. If any pickup definitions are missing, those pickups will not work when the game is played.

	=== Pickup ~~item~~ properties ===		=== Max Amounts ===
			This section of the JSON defines the maximum amounts for each ammo type, health, shields and battery. These apply when picking up items, as well as when using cheats like LAPOSTAL. For battery, it is expressed as a percentage.

			=== Pickup items and their properties ===
	Each pickup item can have the following properties defined. This table lists the properties and what they mean.		Each pickup item can have the following properties defined. This table lists the properties and what they mean.

Line 19:		Line 22:
	! Property !! Type !! Default value !! Description		! Property !! Type !! Default value !! Description
	\|-		\|-
	\| type \|\| string \|\| 'none' \|\| There are 7 types of pickup. These are:		\| type \|\| string \|\| ''none'' \|\| There are 7 types of pickup. These are:
	* <code>objective</code>		* <code>objective</code> - mission objective pickup (eg. Death Star Plans). Adds item to the inventory, triggers the <code>COMPLETE</code> elevator, and updates the objective screen in the PDA.
	* <code>weapon</code>		* <code>weapon</code> - provides the player with an item (usually a weapon, but doesn't have to be) and ammo. Allows for two alternative messages depending on whether the player already has the item.
	* <code>ammo</code>		* <code>ammo</code> - provides the player with ammo, shields, health or battery
	* <code>usable</code>		* <code>usable</code> - adds an inventory item, and can also supply ammo. Is used for gasmask and goggles (where battery "ammo" is supplied together with the item), as well as keys.
	* <code>codekey</code>		* <code>codekey</code> - adds an item to the inventory, and nothing else. Is used for the codekeys.
	* <code>powerup</code>		* <code>powerup</code> - used for the four powerups (supercharges, extra life, revive).
	* <code>special</code>		* <code>special</code> - only used for Kyle's gear ("pile"). Restores all of the player's items on Jabship, and triggers the <code>COMPLETE</code> elevator.
	\|}		\|}

Jerethk: /* Pickup item properties */

2024-12-06T12:11:41Z

Pickup item properties

← Older revision		Revision as of 05:11, 6 December 2024
Line 14:		Line 14:

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

			{\| border=1 cellpadding=6px
			\|-
			! Property !! Type !! Default value !! Description
			\|-
			\| type \|\| string \|\| 'none' \|\| There are 7 types of pickup. These are:
			* <code>objective</code>
			* <code>weapon</code>
			* <code>ammo</code>
			* <code>usable</code>
			* <code>codekey</code>
			* <code>powerup</code>
			* <code>special</code>
			\|}

Jerethk: Created page with "Pickup 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\pickups.json`. Altering the data in `pickups.json` will alter the way that pickup items behave in the game. If the JSON file is removed, renamed or corrupted, pickup items will not work correctly. (In this case, an error message will be logged.) Note that all text in the JSON is case i..."

2024-12-06T12:05:12Z

Created page with "Pickup 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\pickups.json</code>. Altering the data in <code>pickups.json</code> will alter the way that pickup items behave in the game. If the JSON file is removed, renamed or corrupted, pickup items will not work correctly. (In this case, an error message will be logged.) Note that all text in the JSON is case i..."

New page

Pickup 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\pickups.json</code>.

Altering the data in <code>pickups.json</code> will alter the way that pickup items behave in the game. If the JSON file is removed, renamed or corrupted, pickup items 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 pickups and their properties can be listed in any order.

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

Modded versions of <code>pickups.json</code> need to include definitions for all 46 of the pickup items. If any pickup definitions are missing, those pickups will not work when the game is played.

=== Pickup item properties ===
Each pickup item 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.