TFE Custom Logics - Revision history

Jerethk: /* Data properties */ Add new moddable properties that will be available in the next TFE release

2026-01-31T11:59:28Z

Data properties: Add new moddable properties that will be available in the next TFE release

← Older revision		Revision as of 04:59, 31 January 2026
Line 82:		Line 82:
	\|-		\|-
	\| alertSound \|\| string \|\| ''no sound'' \|\| VOC file to play when enemy is alerted		\| alertSound \|\| string \|\| ''no sound'' \|\| VOC file to play when enemy is alerted
			\|-
			\| officerAlerts \|\| boolean \|\| false \|\| If true, the logic will use the Officer alert sounds (eg. "You're not authorised in this area!")
			\|-
			\| troopAlerts \|\| boolean \|\| false \|\| If true, the logic will use the Trooper alert sounds (eg. "Stop rebel scum!")
	\|}		\|}

Line 170:		Line 174:
	\|-		\|-
	\| collisionHeight \|\| number (decimal) \|\| default \|\| Minimum vertical gap (DFU) that enemy can fit through. Defaults to the enemy's world height (determined by the size of the sprite)		\| collisionHeight \|\| number (decimal) \|\| default \|\| Minimum vertical gap (DFU) that enemy can fit through. Defaults to the enemy's world height (determined by the size of the sprite)
			\|-
			\| stepUpHeight \|\| number (decimal) \|\| 3.5 \|\| The maximum step height (difference between floor heights of adjoining sectors) the enemy will be able to "climb" up.
			\|-
			\| stepDownHeight \|\| number (decimal) \|\| 4.0 \|\| The maximum step height (difference between floor heights of adjoining sectors) a non-flying enemy will be willing to "climb" down. Note 1: flying enemies will override any value set here. Note 2: if a very high value is set, the enemy will be willing to walk off a cliff and may fall to their death.
			\|-
			\| slideOnCollision \|\| boolean \|\| <code>true</code> for flying enemies, <code>false</code> for non-flying enemies \|\| If true, the enemy will slide against a wall that they collide with, when they are pushed by a force (eg. an explosion or projectile impact)
	\|}		\|}

Jerethk: /* Data properties */ Update - divide into groups

2026-01-31T11:37:45Z

Data properties: Update - divide into groups

@@ Line 75: / Line 75: @@
 ! Property !! Type !! Default value !! Description
 |-
 | isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
 |-
@@ Line 84: / Line 82: @@
 |-
 | alertSound || string || ''no sound'' || VOC file to play when enemy is alerted
 |-
 | painSound || string || ''no sound'' || VOC file to play when enemy takes pain
 |-
 | dieSound || string || ''no sound'' || VOC file to play when enemy dies
 |-
 | hitPoints || number (integer) || 4 || Hitpoints. The enemy will die when it reaches 0.
@@ Line 100: / Line 101: @@
 |-
 | stopOnDamage || boolean || <code>true</code> || If false, enemy can keep moving while taking damage. (It is set to false for Gamorreans and Probe Droids)
 |-
 | hasMeleeAttack || boolean || <code>false</code> || If true, the enemy will have a melee attack. If the enemy has a melee attack, it will always be the primary attack.
@@ Line 128: / Line 140: @@
 |-
 | fireOffset || array of decimal [x, y, z] || [0.0, default, 0.0] || Projectile spawn location relative to enemy's position and yaw. Default y value is 1 DFU above the middle of the enemy's vertical size (world height, determined by the size of the sprite)
 |-
 | speed || number (integer) || 4 || Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.
@@ Line 140: / Line 159: @@
 |-
 | thinkerDelay || number (integer) || 2 || Average time (in seconds) that the enemy will keep moving in one direction before turning back towards the player
 |-
 | collisionWidth || number (decimal) || default || Minimum distance (DFU) that enemy can approach walls, i.e. half the width of the smallest horizontal gap that it can fit through. Defaults to the the enemy's world width (determined by the size of the sprite)

Jerethk: /* Data properties */

2025-09-02T11:19:34Z

Data properties

← Older revision		Revision as of 04:19, 2 September 2025
Line 99:		Line 99:
	\| dieEffect \|\| string or number \|\| -1 (nothing) \|\| An effect (eg. explosion) that will play when the enemy dies. See reference table below for options.		\| dieEffect \|\| string or number \|\| -1 (nothing) \|\| An effect (eg. explosion) that will play when the enemy dies. See reference table below for options.
	\|-		\|-
	\| stopOnDamage \|\| boolean \|\| <code>true</code> \|\| If false, enemy can keep moving while taking damage		\| stopOnDamage \|\| boolean \|\| <code>true</code> \|\| If false, enemy can keep moving while taking damage. (It is set to false for Gamorreans and Probe Droids)
	\|-		\|-
	\| hasMeleeAttack \|\| boolean \|\| <code>false</code> \|\| If true, the enemy will have a melee attack. If the enemy has a melee attack, it will always be the primary attack.		\| hasMeleeAttack \|\| boolean \|\| <code>false</code> \|\| If true, the enemy will have a melee attack. If the enemy has a melee attack, it will always be the primary attack.
Line 127:		Line 127:
	\| fireSpread \|\| number (integer) \|\| 30 \|\| Accuracy of fire. Lower numbers are more accurate.		\| fireSpread \|\| number (integer) \|\| 30 \|\| Accuracy of fire. Lower numbers are more accurate.
	\|-		\|-
	\| fireOffset \|\| array of decimal [x, y, z] \|\| {0.0, default, 0.0 } \|\| Projectile spawn location relative to enemy's position and yaw. Default y value is 1 DFU above the middle of the enemy's vertical size (world height, determined by the size of the sprite)		\| fireOffset \|\| array of decimal [x, y, z] \|\| [0.0, default, 0.0] \|\| Projectile spawn location relative to enemy's position and yaw. Default y value is 1 DFU above the middle of the enemy's vertical size (world height, determined by the size of the sprite)
	\|-		\|-
	\| speed \|\| number (integer) \|\| 4 \|\| Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.		\| speed \|\| number (integer) \|\| 4 \|\| Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.

Jerethk: Add new properties

2025-09-02T11:16:19Z

Add new properties

← Older revision		Revision as of 04:16, 2 September 2025
Line 98:		Line 98:
	\|-		\|-
	\| dieEffect \|\| string or number \|\| -1 (nothing) \|\| An effect (eg. explosion) that will play when the enemy dies. See reference table below for options.		\| dieEffect \|\| string or number \|\| -1 (nothing) \|\| An effect (eg. explosion) that will play when the enemy dies. See reference table below for options.
			\|-
			\| stopOnDamage \|\| boolean \|\| <code>true</code> \|\| If false, enemy can keep moving while taking damage
	\|-		\|-
	\| hasMeleeAttack \|\| boolean \|\| <code>false</code> \|\| If true, the enemy will have a melee attack. If the enemy has a melee attack, it will always be the primary attack.		\| hasMeleeAttack \|\| boolean \|\| <code>false</code> \|\| If true, the enemy will have a melee attack. If the enemy has a melee attack, it will always be the primary attack.
Line 124:		Line 126:
	\|-		\|-
	\| fireSpread \|\| number (integer) \|\| 30 \|\| Accuracy of fire. Lower numbers are more accurate.		\| fireSpread \|\| number (integer) \|\| 30 \|\| Accuracy of fire. Lower numbers are more accurate.
			\|-
			\| fireOffset \|\| array of decimal [x, y, z] \|\| {0.0, default, 0.0 } \|\| Projectile spawn location relative to enemy's position and yaw. Default y value is 1 DFU above the middle of the enemy's vertical size (world height, determined by the size of the sprite)
	\|-		\|-
	\| speed \|\| number (integer) \|\| 4 \|\| Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.		\| speed \|\| number (integer) \|\| 4 \|\| Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.
Line 130:		Line 134:
	\|-		\|-
	\| rotationSpeed \|\| number (integer) \|\| 720 \|\| Speed at which the enemy can rotate. Degrees per second.		\| rotationSpeed \|\| number (integer) \|\| 720 \|\| Speed at which the enemy can rotate. Degrees per second.
			\|-
			\| approachVariation \|\| number (integer) \|\| 90 \|\| An angle in degrees; affects the way enemies approach the player
			\|-
			\| approachOffset \|\| number (integer) \|\| 3 \|\| Minimum distance (DFU) that the enemy will approach the player
			\|-
			\| thinkerDelay \|\| number (integer) \|\| 2 \|\| Average time (in seconds) that the enemy will keep moving in one direction before turning back towards the player
			\|-
			\| collisionWidth \|\| number (decimal) \|\| default \|\| Minimum distance (DFU) that enemy can approach walls, i.e. half the width of the smallest horizontal gap that it can fit through. Defaults to the the enemy's world width (determined by the size of the sprite)
			\|-
			\| collisionHeight \|\| number (decimal) \|\| default \|\| Minimum vertical gap (DFU) that enemy can fit through. Defaults to the enemy's world height (determined by the size of the sprite)
	\|}		\|}

Jerethk at 04:19, 31 August 2025

2025-08-31T04:19:13Z

← Older revision		Revision as of 21:19, 30 August 2025
Line 1:		Line 1:
	This article explains how to use custom (user-defined) AI logics in TFE. ~~(The feature is not yet available but will be coming in a future official release.)~~		This article explains how to use custom (user-defined) AI logics in TFE.

	This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.		This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.

	To use the feature, check that the '''~~Enable custom~~ AI logics ~~from JSON files~~''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.		To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

	=== JSON locations ===		=== JSON locations ===

Jerethk: /* JSON locations */

2024-10-30T04:56:04Z

JSON locations

← Older revision		Revision as of 21:56, 29 October 2024
Line 20:		Line 20:
	You can have as many logic .JSON files as you want, and each .JSON file can contain as many logics as you want. If multiple logics are loaded that have the same name, only the first one encountered with that name will be used. If you have multiple .JSON files, the order in which they are loaded by TFE is unpredictable, so the only way to be sure that your logics work the way you intend is to avoid duplicate names.		You can have as many logic .JSON files as you want, and each .JSON file can contain as many logics as you want. If multiple logics are loaded that have the same name, only the first one encountered with that name will be used. If you have multiple .JSON files, the order in which they are loaded by TFE is unpredictable, so the only way to be sure that your logics work the way you intend is to avoid duplicate names.

	'''Note''': Custom logics are loaded when entering Dark Forces from TFE, and cleared when the user exits back to the TFE main menu. Therefore, if JSON files are ~~amended~~ while the game is running, the change will take effect when you quit back to the TFE main menu and then re-enter the game.		'''Note''': Custom logics are loaded when entering Dark Forces from TFE, and cleared when the user exits back to the TFE main menu. Therefore, if JSON files are altered while the game is running, the change will take effect when you quit back to the TFE main menu and then re-enter the game.

	=== Logic JSON structure ===		=== Logic JSON structure ===

Jerethk: /* JSON locations */

2024-10-30T04:55:25Z

JSON locations

← Older revision		Revision as of 21:55, 29 October 2024
Line 19:		Line 19:

	You can have as many logic .JSON files as you want, and each .JSON file can contain as many logics as you want. If multiple logics are loaded that have the same name, only the first one encountered with that name will be used. If you have multiple .JSON files, the order in which they are loaded by TFE is unpredictable, so the only way to be sure that your logics work the way you intend is to avoid duplicate names.		You can have as many logic .JSON files as you want, and each .JSON file can contain as many logics as you want. If multiple logics are loaded that have the same name, only the first one encountered with that name will be used. If you have multiple .JSON files, the order in which they are loaded by TFE is unpredictable, so the only way to be sure that your logics work the way you intend is to avoid duplicate names.

			'''Note''': Custom logics are loaded when entering Dark Forces from TFE, and cleared when the user exits back to the TFE main menu. Therefore, if JSON files are amended while the game is running, the change will take effect when you quit back to the TFE main menu and then re-enter the game.

	=== Logic JSON structure ===		=== Logic JSON structure ===

Jerethk: note about settings

2024-10-30T03:05:58Z

note about settings

← Older revision		Revision as of 20:05, 29 October 2024
Line 2:		Line 2:

	This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.		This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.

			To use the feature, check that the '''Enable custom AI logics from JSON files''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

	=== JSON locations ===		=== JSON locations ===

Jerethk at 02:50, 30 October 2024

2024-10-30T02:50:39Z

← Older revision		Revision as of 19:50, 29 October 2024
Line 1:		Line 1:
	This article explains how to use custom (user-defined) AI logics in TFE.		This article explains how to use custom (user-defined) AI logics in TFE. (The feature is not yet available but will be coming in a future official release.)

	This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.		This feature allows modders to create new enemy logics that behave similarly to the "standard" (non-boss) enemies in Dark Forces, for example Officers, Stormtroopers, Bossk, Probe Droids.
Line 8:		Line 8:
	* DARK\Logics		* DARK\Logics
	* TheForceEngine\Mods\Logics		* TheForceEngine\Mods\Logics
			* TheForceEngine\Mods\<code>[CURRENTLY LOADED MOD]</code>\Logics

	where DARK is your Dark Forces game directory which TFE is pointing to.		where DARK is your Dark Forces game directory which TFE is pointing to.

Jerethk: /* Custom logics and WAX files */

2024-10-29T05:13:18Z

Custom logics and WAX files

← Older revision		Revision as of 22:13, 28 October 2024
Line 184:		Line 184:
	\| 5 \|\| Idle / stationary		\| 5 \|\| Idle / stationary
	\|-		\|-
	\| 6 \|\| ~~After primary~~ attack (eg. recoil)		\| 6 \|\| Primary attack conclusion (eg. recoil)
	\|-		\|-
	\| 7 \|\| Secondary attack		\| 7 \|\| Secondary attack
	\|-		\|-
	\| 8 \|\| ~~After secondary~~ attack		\| 8 \|\| Secondary attack conclusion
	\|-		\|-
	\| 9 \|\| ''unused''		\| 9 \|\| ''unused''