DF21 Wiki - User contributions [en]

TFE Custom Logics

2026-01-31T11:59:28Z

Jerethk: /* Data properties */ Add new moddable properties that will be available in the next TFE 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.

To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

=== JSON locations ===
Custom logics are defined in JSON files. TFE will search for and load logics from all logic .JSON files found in these locations

* DARK\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.

In addition, if you are running a Mod from a ZIP, TFE will look for a <code>\Logics</code> subfolder inside the ZIP and load logics from any .JSON files found there.

Logics loaded from a Mod will take preference over any logics found in other locations that have the same name.

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 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 ===
A logic JSON should consist of a single array called "logics".

Each element of the "logics" array must consist of two items, in this order
* "logicName" - a string which is the name of the logic
* "data" - an object containing properties that are set for the logic

Example:
<pre>
{
"logics": [
{
"logicName": "LogicA",
"data": {
"alertSound": "alert1.voc",
"painSound": "pain1.voc",
"hitpoints": 25,
"projectile": "rifle_bolt"
}
},
{
"logicName": "LogicB",
"data": {
"alertSound": "alert2.voc",
"painSound": "pain2.voc",
"hitpoints": 39,
"speed": 20,
"projectile": "thermal_det",
"dropItem": "red_key"
}
}
]
}
</pre>

Logic JSONs are ''not'' case sensitive. The text inside the JSON can be all uppercase, all lowercase, or any mix of upper and lowercase; it will all be read the same.

For example, "alertsound", "ALERTSOUND", "AlertSound", "alertSound" will all be accepted.

Further tips about getting the JSON format right can be found on the [[TFE Mod Overrides#How_do_I_create_or_edit_a_MOD_CONF.txt_file_and_what_is_JSON?|TFE MOD Overrides]] article.

=== Data properties ===
Here is a list of the properties that you can set for each logic. They are all standard JSON key-value pairs.

You do not need to set every property. Unset properties will default to the values shown.

Properties can be listed in any order. Property names are not case sensitive, but need to be spelled correctly.

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
|-
| fieldOfView || number (integer) || 210 || Field of view, in degrees. If set to 360, the enemy will be able to see you even if you are standing behind it.
|-
| awareRange || number (integer) || 20 || If you are within this distance from the enemy (in DFU), it will be alerted even if you are outside its field of view. (However, this can be affected by other things, such as the ambient light.)
|-
| 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!")
|}

==== Damage properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| 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.
|-
| dropItem || string or number || -1 (nothing) || What item is dropped 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. (It is set to false for Gamorreans and Probe Droids)
|}

==== Attack properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| attack1Sound || string || ''no sound'' || VOC file to play for primary attack
|-
| attack2Sound || string || ''no sound'' || VOC file to play for secondary 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.
|-
| hasRangedAttack || boolean || <code>true</code> || If true, the enemy will have a ranged attack. If the enemy has a melee attack, the ranged attack will be the secondary attack. If it does not have a melee attack, the ranged attack will be the primary attack.
|-
| litWithMeleeAttack || boolean || <code>false</code> || If true, the sprite will light up when it attacks with melee.
|-
| litWithRangedAttack || boolean || <code>true</code> || If true, the sprite will light up when it does its ranged attack.
|-
| projectile || string or number || <code>"rifle_bolt"</code> || What projectile the enemy will fire for its ranged attack. See reference table below for options.
|-
| wanderTime || number (integer) || 300 || How long (in seconds) the enemy will keep looking for the player, before it returns to its idle or "asleep" state. This time is reset when the enemy is re-alerted by the player.
|-
| rangedAttackDelay || number (decimal) || 2 || Time delay in seconds between range attacks (the game engine adds some variability to this)
|-
| meleeAttackDelay || number (decimal) || 0 || Time delay in seconds between melee attacks
|-
| meleeRange || number (integer) || 0 || Range (in DFU) of melee attack - how far the player can be from the enemy to be hit by it.
|-
| meleeDamage || number (integer) || 0 || Damage that each melee attack will inflict.
|-
| minAttackDist || number (integer) || 0 || Minimum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| maxAttackDist || number (integer) || 160 || Maximum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| 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)
|}

==== Thinker properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| speed || number (integer) || 4 || Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.
|-
| verticalSpeed || number (integer) || 10 || For flying enemies only, this is their vertical speed.
|-
| 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
|}

==== Physics properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| 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)
|-
| 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)
|}

=== Using custom logics ===
Logics that you have defined in JSON can be applied to a sprite in the .O file in the same way as other (hardcoded) enemy logics. For example, if you have the following logic

<pre>
"logicName": "Rodian",
"data": {
"alertSound": "rodian1.voc",
....
}
</pre>

Apply it to a sprite (WAX) like this, and then the sprite should behave with the custom logic.

<pre>
SEQ
LOGIC: Rodian
SEQEND
</pre>

You can also use JSON-defined logics with generators, for example

<pre>
SEQ
LOGIC: GENERATOR Rodian
DELAY: 10
INTERVAL: 5
NUM_TERMINATE: 6
MAX_ALIVE: 1
MAX_DIST: 800
MIN_DIST: 50
SEQEND
</pre>

'''Important''': If a level with a custom logic is run with vanilla Dark Forces or the Dark Forces Remaster, the sprites will be "lifeless". However, if the level has generators with a custom logic, this causes the original game to crash.

=== Overriding hardcoded logics ===
You ''can'' override hardcoded logics by creating a JSON logic with the same name as one of the hardcoded logics. For example, <code>storm1</code> and <code>commando</code>.

If you override a boss logic, like <code>kell</code> or one of the dark troopers, the enemy will behave like an ordinary enemy instead of a boss; they will lose their ability to trigger the BOSS elevator when they die.

=== Custom logics and WAX files ===
A custom logic's behaviours/actions will correspond to WAX animations as follows

{| border=1 cellpadding=6px
|-
| 0 || Walking / moving
|-
| 1 || Primary attack
|-
| 2 || Melee death
|-
| 3 || Shooting / explosion death
|-
| 4 || Dead
|-
| 5 || Idle / stationary
|-
| 6 || Primary attack conclusion (eg. recoil)
|-
| 7 || Secondary attack
|-
| 8 || Secondary attack conclusion
|-
| 9 || ''unused''
|-
| 10 || ''unused''
|-
| 11 || ''unused''
|-
| 12 || Pain
|}

This follows the same pattern as all the standard Dark Forces enemies.

Note that if a logic has a melee attack, this will always be the primary attack (animations 1 and 6). If a logic has ''only'' a ranged attack, then this will be the primary attack (animations 1 and 6). If a logic has both melee and ranged attacks, the melee will be primary (animations 1 and 6) and the ranged attack will be secondary (animations 7 and 8).

=== Reference ===
==== Projectile list ====
You can assign projectiles with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a projectile
|-
| 0 || <code>punch</code> || This is a special projectile used for the player's fists, and may not work with logics
|-
| 1 || <code>pistol_bolt</code>
|-
| 2 || <code>rifle_bolt</code>
|-
| 3 || <code>thermal_det</code>
|-
| 4 || <code>repeater</code>
|-
| 5 || <code>plasma</code> || Fusion cutter projectile
|-
| 6 || <code>mortar</code>
|-
| 7 || <code>land_mine</code>
|-
| 8 || <code>land_mine_prox</code> || Proximity land mine
|-
| 9 || <code>land_mine_placed</code>
|-
| 10 || <code>concussion</code>
|-
| 11 || <code>cannon</code>
|-
| 12 || <code>missile</code>
|-
| 13 || <code>turret_bolt</code>
|-
| 14 || <code>remote_bolt</code>
|-
| 15 || <code>exp_barrel</code> || An invisible projectile that is normally spawned when a barrel explodes
|-
| 16 || <code>homing_missile</code> || Mohc's homing missiles
|-
| 17 || <code>probe_proj</code> || Green interrogator droid projectile
|-
| 18 || <code>bobafett_ball</code> || Boba Fett's missiles
|}

==== Drop item list ====
You can assign drop items with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not drop anything when they die
|-
| 0 || <code>PLANS</code> || Death Star plans
|-
| 1 || <code>PHRIK</code>
|-
| 2 || <code>NAVA</code>
|-
| 3 || <code>DT_WEAPON</code>
|-
| 4 || <code>DATATAPE</code>
|-
| 5 || <code>RIFLE</code>
|-
| 6 || <code>AUTOGUN</code>
|-
| 7 || <code>MORTAR</code>
|-
| 8 || <code>FUSION</code>
|-
| 9 || <code>CONCUSSION</code>
|-
| 10 || <code>CANNON</code>
|-
| 11 || <code>ENERGY</code>
|-
| 12 || <code>POWER</code>
|-
| 13 || <code>PLASMA</code>
|-
| 14 || <code>DETONATOR</code>
|-
| 15 || <code>DETONATORS</code>
|-
| 16 || <code>SHELL</code> || Mortar shell
|-
| 17 || <code>SHELLS</code>
|-
| 18 || <code>MINE</code>
|-
| 19 || <code>MINES</code>
|-
| 20 || <code>MISSILE</code>
|-
| 21 || <code>MISSILES</code>
|-
| 22 || <code>SHIELD</code>
|-
| 23 || <code>RED_KEY</code>
|-
| 24 || <code>YELLOW_KEY</code>
|-
| 25 || <code>BLUE_KEY</code>
|-
| 26 || <code>GOGGLES</code>
|-
| 27 || <code>CLEATS</code>
|-
| 28 || <code>MASK</code> || Gas mask
|-
| 29 || <code>BATTERY</code>
|-
| 30 || <code>CODE1</code>
|-
| 31 || <code>CODE2</code>
|-
| 32 || <code>CODE3</code>
|-
| 33 || <code>CODE4</code>
|-
| 34 || <code>CODE5</code>
|-
| 35 || <code>CODE6</code>
|-
| 36 || <code>CODE7</code>
|-
| 37 || <code>CODE8</code>
|-
| 38 || <code>CODE9</code>
|-
| 39 || <code>INVINCIBLE</code> || Shield supercharge
|-
| 40 || <code>SUPERCHARGE</code> || Weapon supercharge
|-
| 41 || <code>REVIVE</code>
|-
| 42 || <code>LIFE</code>
|-
| 43 || <code>MEDKIT</code>
|-
| 44 || <code>PILE</code> || Kyle's pile of weapons
|}

==== Death effect list ====
You can assign death effects with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

Note that some effects inflict damage.

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a death effect
|-
| 0 || <code>SMALL_EXP</code> || small "puff" - blaster weapons
|-
| 1 || <code>THERMDET_EXP</code> || thermal detonator explosion
|-
| 2 || <code>PLASMA_EXP</code> || Green plasma "puff"
|-
| 3 || <code>MORTAR_EXP</code> || mortar explosion
|-
| 4 || <code>CONCUSSION</code> || concussion - first stage
|-
| 5 || <code>CONCUSSION2</code> || concussion - second stage
|-
| 6 || <code>MISSILE_EXP</code> || missile explosion
|-
| 7 || <code>MISSILE_WEAK</code> || weaker version of the missle explosion
|-
| 8 || <code>PUNCH</code> || punch
|-
| 9 || <code>CANNON_EXP</code> || Blue cannon "puff"
|-
| 10 || <code>REPEATER_EXP</code> || repeater "puff"
|-
| 11 || <code>LARGE_EXP</code> || Land mine explosion
|-
| 12 || <code>EXP_BARREL</code> || exploding barrel
|-
| 13 || <code>EXP_INVIS</code> || an explosion that makes no sound and has no visual effect
|-
| 14 || <code>SPLASH</code> || water splash
|-
| 15 || <code>EXP_35</code> || medium explosion, 35 damage (used for probe droid death)
|-
| 16 || <code>EXP_NO_DMG</code> || medium explosion, no damage (used for turret and welder deaths)
|-
| 17 || <code>EXP_25</code> || medium explosion, 25 damage (used for Boba Fett missile explosions)
|}

TFE Custom Logics

2026-01-31T11:37:45Z

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

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.

To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

=== JSON locations ===
Custom logics are defined in JSON files. TFE will search for and load logics from all logic .JSON files found in these locations

* DARK\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.

In addition, if you are running a Mod from a ZIP, TFE will look for a <code>\Logics</code> subfolder inside the ZIP and load logics from any .JSON files found there.

Logics loaded from a Mod will take preference over any logics found in other locations that have the same name.

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 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 ===
A logic JSON should consist of a single array called "logics".

Each element of the "logics" array must consist of two items, in this order
* "logicName" - a string which is the name of the logic
* "data" - an object containing properties that are set for the logic

Example:
<pre>
{
"logics": [
{
"logicName": "LogicA",
"data": {
"alertSound": "alert1.voc",
"painSound": "pain1.voc",
"hitpoints": 25,
"projectile": "rifle_bolt"
}
},
{
"logicName": "LogicB",
"data": {
"alertSound": "alert2.voc",
"painSound": "pain2.voc",
"hitpoints": 39,
"speed": 20,
"projectile": "thermal_det",
"dropItem": "red_key"
}
}
]
}
</pre>

Logic JSONs are ''not'' case sensitive. The text inside the JSON can be all uppercase, all lowercase, or any mix of upper and lowercase; it will all be read the same.

For example, "alertsound", "ALERTSOUND", "AlertSound", "alertSound" will all be accepted.

Further tips about getting the JSON format right can be found on the [[TFE Mod Overrides#How_do_I_create_or_edit_a_MOD_CONF.txt_file_and_what_is_JSON?|TFE MOD Overrides]] article.

=== Data properties ===
Here is a list of the properties that you can set for each logic. They are all standard JSON key-value pairs.

You do not need to set every property. Unset properties will default to the values shown.

Properties can be listed in any order. Property names are not case sensitive, but need to be spelled correctly.

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
|-
| fieldOfView || number (integer) || 210 || Field of view, in degrees. If set to 360, the enemy will be able to see you even if you are standing behind it.
|-
| awareRange || number (integer) || 20 || If you are within this distance from the enemy (in DFU), it will be alerted even if you are outside its field of view. (However, this can be affected by other things, such as the ambient light.)
|-
| alertSound || string || ''no sound'' || VOC file to play when enemy is alerted
|}

==== Damage properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| 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.
|-
| dropItem || string or number || -1 (nothing) || What item is dropped 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. (It is set to false for Gamorreans and Probe Droids)
|}

==== Attack properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| attack1Sound || string || ''no sound'' || VOC file to play for primary attack
|-
| attack2Sound || string || ''no sound'' || VOC file to play for secondary 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.
|-
| hasRangedAttack || boolean || <code>true</code> || If true, the enemy will have a ranged attack. If the enemy has a melee attack, the ranged attack will be the secondary attack. If it does not have a melee attack, the ranged attack will be the primary attack.
|-
| litWithMeleeAttack || boolean || <code>false</code> || If true, the sprite will light up when it attacks with melee.
|-
| litWithRangedAttack || boolean || <code>true</code> || If true, the sprite will light up when it does its ranged attack.
|-
| projectile || string or number || <code>"rifle_bolt"</code> || What projectile the enemy will fire for its ranged attack. See reference table below for options.
|-
| wanderTime || number (integer) || 300 || How long (in seconds) the enemy will keep looking for the player, before it returns to its idle or "asleep" state. This time is reset when the enemy is re-alerted by the player.
|-
| rangedAttackDelay || number (decimal) || 2 || Time delay in seconds between range attacks (the game engine adds some variability to this)
|-
| meleeAttackDelay || number (decimal) || 0 || Time delay in seconds between melee attacks
|-
| meleeRange || number (integer) || 0 || Range (in DFU) of melee attack - how far the player can be from the enemy to be hit by it.
|-
| meleeDamage || number (integer) || 0 || Damage that each melee attack will inflict.
|-
| minAttackDist || number (integer) || 0 || Minimum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| maxAttackDist || number (integer) || 160 || Maximum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| 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)
|}

==== Thinker properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| speed || number (integer) || 4 || Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.
|-
| verticalSpeed || number (integer) || 10 || For flying enemies only, this is their vertical speed.
|-
| 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
|}

==== Physics properties ====

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| 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)
|}

=== Using custom logics ===
Logics that you have defined in JSON can be applied to a sprite in the .O file in the same way as other (hardcoded) enemy logics. For example, if you have the following logic

<pre>
"logicName": "Rodian",
"data": {
"alertSound": "rodian1.voc",
....
}
</pre>

Apply it to a sprite (WAX) like this, and then the sprite should behave with the custom logic.

<pre>
SEQ
LOGIC: Rodian
SEQEND
</pre>

You can also use JSON-defined logics with generators, for example

<pre>
SEQ
LOGIC: GENERATOR Rodian
DELAY: 10
INTERVAL: 5
NUM_TERMINATE: 6
MAX_ALIVE: 1
MAX_DIST: 800
MIN_DIST: 50
SEQEND
</pre>

'''Important''': If a level with a custom logic is run with vanilla Dark Forces or the Dark Forces Remaster, the sprites will be "lifeless". However, if the level has generators with a custom logic, this causes the original game to crash.

=== Overriding hardcoded logics ===
You ''can'' override hardcoded logics by creating a JSON logic with the same name as one of the hardcoded logics. For example, <code>storm1</code> and <code>commando</code>.

If you override a boss logic, like <code>kell</code> or one of the dark troopers, the enemy will behave like an ordinary enemy instead of a boss; they will lose their ability to trigger the BOSS elevator when they die.

=== Custom logics and WAX files ===
A custom logic's behaviours/actions will correspond to WAX animations as follows

{| border=1 cellpadding=6px
|-
| 0 || Walking / moving
|-
| 1 || Primary attack
|-
| 2 || Melee death
|-
| 3 || Shooting / explosion death
|-
| 4 || Dead
|-
| 5 || Idle / stationary
|-
| 6 || Primary attack conclusion (eg. recoil)
|-
| 7 || Secondary attack
|-
| 8 || Secondary attack conclusion
|-
| 9 || ''unused''
|-
| 10 || ''unused''
|-
| 11 || ''unused''
|-
| 12 || Pain
|}

This follows the same pattern as all the standard Dark Forces enemies.

Note that if a logic has a melee attack, this will always be the primary attack (animations 1 and 6). If a logic has ''only'' a ranged attack, then this will be the primary attack (animations 1 and 6). If a logic has both melee and ranged attacks, the melee will be primary (animations 1 and 6) and the ranged attack will be secondary (animations 7 and 8).

=== Reference ===
==== Projectile list ====
You can assign projectiles with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a projectile
|-
| 0 || <code>punch</code> || This is a special projectile used for the player's fists, and may not work with logics
|-
| 1 || <code>pistol_bolt</code>
|-
| 2 || <code>rifle_bolt</code>
|-
| 3 || <code>thermal_det</code>
|-
| 4 || <code>repeater</code>
|-
| 5 || <code>plasma</code> || Fusion cutter projectile
|-
| 6 || <code>mortar</code>
|-
| 7 || <code>land_mine</code>
|-
| 8 || <code>land_mine_prox</code> || Proximity land mine
|-
| 9 || <code>land_mine_placed</code>
|-
| 10 || <code>concussion</code>
|-
| 11 || <code>cannon</code>
|-
| 12 || <code>missile</code>
|-
| 13 || <code>turret_bolt</code>
|-
| 14 || <code>remote_bolt</code>
|-
| 15 || <code>exp_barrel</code> || An invisible projectile that is normally spawned when a barrel explodes
|-
| 16 || <code>homing_missile</code> || Mohc's homing missiles
|-
| 17 || <code>probe_proj</code> || Green interrogator droid projectile
|-
| 18 || <code>bobafett_ball</code> || Boba Fett's missiles
|}

==== Drop item list ====
You can assign drop items with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not drop anything when they die
|-
| 0 || <code>PLANS</code> || Death Star plans
|-
| 1 || <code>PHRIK</code>
|-
| 2 || <code>NAVA</code>
|-
| 3 || <code>DT_WEAPON</code>
|-
| 4 || <code>DATATAPE</code>
|-
| 5 || <code>RIFLE</code>
|-
| 6 || <code>AUTOGUN</code>
|-
| 7 || <code>MORTAR</code>
|-
| 8 || <code>FUSION</code>
|-
| 9 || <code>CONCUSSION</code>
|-
| 10 || <code>CANNON</code>
|-
| 11 || <code>ENERGY</code>
|-
| 12 || <code>POWER</code>
|-
| 13 || <code>PLASMA</code>
|-
| 14 || <code>DETONATOR</code>
|-
| 15 || <code>DETONATORS</code>
|-
| 16 || <code>SHELL</code> || Mortar shell
|-
| 17 || <code>SHELLS</code>
|-
| 18 || <code>MINE</code>
|-
| 19 || <code>MINES</code>
|-
| 20 || <code>MISSILE</code>
|-
| 21 || <code>MISSILES</code>
|-
| 22 || <code>SHIELD</code>
|-
| 23 || <code>RED_KEY</code>
|-
| 24 || <code>YELLOW_KEY</code>
|-
| 25 || <code>BLUE_KEY</code>
|-
| 26 || <code>GOGGLES</code>
|-
| 27 || <code>CLEATS</code>
|-
| 28 || <code>MASK</code> || Gas mask
|-
| 29 || <code>BATTERY</code>
|-
| 30 || <code>CODE1</code>
|-
| 31 || <code>CODE2</code>
|-
| 32 || <code>CODE3</code>
|-
| 33 || <code>CODE4</code>
|-
| 34 || <code>CODE5</code>
|-
| 35 || <code>CODE6</code>
|-
| 36 || <code>CODE7</code>
|-
| 37 || <code>CODE8</code>
|-
| 38 || <code>CODE9</code>
|-
| 39 || <code>INVINCIBLE</code> || Shield supercharge
|-
| 40 || <code>SUPERCHARGE</code> || Weapon supercharge
|-
| 41 || <code>REVIVE</code>
|-
| 42 || <code>LIFE</code>
|-
| 43 || <code>MEDKIT</code>
|-
| 44 || <code>PILE</code> || Kyle's pile of weapons
|}

==== Death effect list ====
You can assign death effects with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

Note that some effects inflict damage.

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a death effect
|-
| 0 || <code>SMALL_EXP</code> || small "puff" - blaster weapons
|-
| 1 || <code>THERMDET_EXP</code> || thermal detonator explosion
|-
| 2 || <code>PLASMA_EXP</code> || Green plasma "puff"
|-
| 3 || <code>MORTAR_EXP</code> || mortar explosion
|-
| 4 || <code>CONCUSSION</code> || concussion - first stage
|-
| 5 || <code>CONCUSSION2</code> || concussion - second stage
|-
| 6 || <code>MISSILE_EXP</code> || missile explosion
|-
| 7 || <code>MISSILE_WEAK</code> || weaker version of the missle explosion
|-
| 8 || <code>PUNCH</code> || punch
|-
| 9 || <code>CANNON_EXP</code> || Blue cannon "puff"
|-
| 10 || <code>REPEATER_EXP</code> || repeater "puff"
|-
| 11 || <code>LARGE_EXP</code> || Land mine explosion
|-
| 12 || <code>EXP_BARREL</code> || exploding barrel
|-
| 13 || <code>EXP_INVIS</code> || an explosion that makes no sound and has no visual effect
|-
| 14 || <code>SPLASH</code> || water splash
|-
| 15 || <code>EXP_35</code> || medium explosion, 35 damage (used for probe droid death)
|-
| 16 || <code>EXP_NO_DMG</code> || medium explosion, no damage (used for turret and welder deaths)
|-
| 17 || <code>EXP_25</code> || medium explosion, 25 damage (used for Boba Fett missile explosions)
|}

Script Object

2025-09-26T07:14:47Z

Jerethk: /* Object Properties */

The '''Script Object''' API enables manipulation of objects via ForceScript.

== Naming of objects ==
TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names.

Objects are named in the .O file as shown here:

<pre>
/* 006 SEWERBUG.WAX */
CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: SEWER1
NAME: sewer-creature2
SEQEND

/* 007 REMOTE.WAX */
CLASS: SPRITE DATA: 2 X: 280.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: REMOTE
NAME: cool-remote
SEQEND

/* 008 MOUSEBOT.3DO */
CLASS: 3D DATA: 2 X: 256.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: MOUSEBOT
NAME: mouse4
SEQEND
</pre>

== Getting objects by name ==
To get objects by their name, use the methods in the [[Level_Script_API#Methods|Level Script]] API.
* <code>getObject</code>
* <code>getObjectsByName</code>

Once an object has been gotten by name, the script can do things with it.

Example:
<pre>
Object mb1 = level.getObject("mousebot1");

if (mb1.exists())
{
// Get the mousebot's position and move it eastwards by 20 units
float3 pos = mb1.position;
mb1.position = { pos.x + 20, pos.y, pos.z };
}

</pre>

== Enums ==
=== <code>Projectile</code> enum ===
{|
|-
| PROJ_PUNCH
|-
| PROJ_PISTOL_BOLT
|-
| PROJ_RIFLE_BOLT
|-
| PROJ_THERMAL_DET
|-
| PROJ_REPEATER
|-
| PROJ_PLASMA
|-
| PROJ_MORTAR
|-
| PROJ_LAND_MINE
|-
| PROJ_LAND_MINE_PROX
|-
| PROJ_LAND_MINE_PLACED
|-
| PROJ_CONCUSSION
|-
| PROJ_CANNON
|-
| PROJ_MISSILE
|-
| PROJ_TURRET_BOLT
|-
| PROJ_REMOTE_BOLT
|-
| PROJ_EXP_BARREL
|-
| PROJ_HOMING_MISSILE
|-
| PROJ_PROBE_PROJ
|-
| PROJ_BOBAFETT_BALL
|}

=== <code>LogicSound</code> enum ===
{|
|-
| SND_ALERT
|-
| SND_PAIN
|-
| SND_DIE
|-
| SND_ATTACK1
|-
| SND_ATTACK2
|}

== Object Properties ==

=== sector ===
* Get only
* Gets the object's current sector (<code>Sector</code>)
* Usage example: <code>Sector troopSector = my_trooper.sector</code>

=== position ===
* Get or set
* Gets or sets the object's position (float3)
* Usage example: move the object to coordinates x20, y80, z-350
<pre>
myObj.position = {20, 80, -350};
</pre>

=== yaw ===
* Get or set
* Gets or sets the object's yaw (float)
* Usage example: <code>myObj.yaw = 120.0;</code>

=== radius ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.radius = 1.5;</code>

=== worldWidth ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

=== height ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.height = 9.5;</code>

=== worldHeight ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

== Object Properties: Logics ==
The following properties apply to objects that have an AI logic.

=== hitPoints ===
* Get or set
* Gets or sets the logic's hitpoints. Works for all AIs including bosses, scenery, and barrels
* Usage example: <code>myObj.hitpoints = 100;</code>

=== velocity ===
* Get or set
* Gets or sets the logic's velocity (float3). Works for bosses as well as ordinary AIs.
* Usage example: set logic's velocity to 60 units upwards and 40 units northward
<pre>
trooper.velocity = {0.0, 60.0, 40.0};
</pre>

=== projectile ===
* Set only
* Sets the logic's attack projectile. Only works on ordinary enemies (including custom logics), not bosses
* Usage example: change the logic's projectile to mortars
<pre>
commando.projectile = PROJ_MORTAR;
</pre>

== Object Methods ==

=== exists() ===
* Returns <code>true</code> if the object exists, otherwise returns <code>false</code>
* Usage example:
<pre>
Object trooper = level.getObject("stormtrooper3");

if (trooper.exists())
{
...
...
}
</pre>

Note: Scripting functions will internally do an ''exists'' check before being executed. Therefore it is not necessary for you to check that an object exists in ForceScript before calling methods on it. If you try to manipulate an object (eg. set its position) that doesn't exist, nothing will happen. If you ''get'' a property from a non-existent object, a default value will be returned (usually zero).

The <code>exists()</code> function in ForceScript enables you to check for an object's existence so that you can make your script logic conditional on an object's existence. For example, you may want your script to do something only if a certain enemy has been killed, or a certain item has been collected.

=== isPlayer() ===
* returns <code>true</code> if the object is the player, otherwise returns <code>false</code>

=== matchPosition(Object) ===
* moves the object to the same position as another object
* usage example:
<pre>
Object target = level.getObject("spirit7");
Object ds = level.getObject("deathstar_plans");

// move the death star plans to the same position as the spirit marker
ds.matchPosition(target);
</pre>

=== matchPosition(string) ===
* moves the object to the same position as another object by name
* usage example:
<pre>
// does the same as the above example, but uses the object's name
ds.matchPosition("spirit7");
</pre>

=== delete() ===
* Removes the object from the level
* usage example: <code>ewok2.delete();</code>

=== addLogic(string) ===
* Adds a logic to the object. Works with scenery, enemy logics, and pickup items. (Still to do: enable adding a custom logic.)
* usage example:
<pre>
// turn the table into scenery so it becomes breakable
table.addLogic("scenery");

// add Nava card logic to the object so it can now be picked up
navcard.addLogic("nava");

// add commando logic
com5.addLogic("commando");
</pre>

=== setCamera() ===
* Set the camera (EYE) to the object
* Usage example:
<pre>
Object cutsceneCam = level.getObject("camera9");
cutsceneCam.setCamera();
</pre>

=== sendMessage(MessageType) ===
* Sends a message to the object
* Parameter: <code>MessageType</code> enum

* Valid <code>MessageTypes</code> that can be sent to objects
** <code>WAKEUP</code> - if the object has an AI logic, this message will change it from idle state to alerted state (does not work on bosses)
** <code>CRUSH</code> - if the object has an AI logic, instantly kills it (does not work on bosses)

Usage example
<pre>
// Alerts the gamorrean guard
Object gamor = level.getObject("gamguard");
gamor.sendMessage(WAKEUP);
</pre>

Script Object

2025-09-26T06:54:35Z

Jerethk: Enums

The '''Script Object''' API enables manipulation of objects via ForceScript.

== Naming of objects ==
TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names.

Objects are named in the .O file as shown here:

<pre>
/* 006 SEWERBUG.WAX */
CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: SEWER1
NAME: sewer-creature2
SEQEND

/* 007 REMOTE.WAX */
CLASS: SPRITE DATA: 2 X: 280.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: REMOTE
NAME: cool-remote
SEQEND

/* 008 MOUSEBOT.3DO */
CLASS: 3D DATA: 2 X: 256.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: MOUSEBOT
NAME: mouse4
SEQEND
</pre>

== Getting objects by name ==
To get objects by their name, use the methods in the [[Level_Script_API#Methods|Level Script]] API.
* <code>getObject</code>
* <code>getObjectsByName</code>

Once an object has been gotten by name, the script can do things with it.

Example:
<pre>
Object mb1 = level.getObject("mousebot1");

if (mb1.exists())
{
// Get the mousebot's position and move it eastwards by 20 units
float3 pos = mb1.position;
mb1.position = { pos.x + 20, pos.y, pos.z };
}

</pre>

== Enums ==
=== <code>Projectile</code> enum ===
{|
|-
| PROJ_PUNCH
|-
| PROJ_PISTOL_BOLT
|-
| PROJ_RIFLE_BOLT
|-
| PROJ_THERMAL_DET
|-
| PROJ_REPEATER
|-
| PROJ_PLASMA
|-
| PROJ_MORTAR
|-
| PROJ_LAND_MINE
|-
| PROJ_LAND_MINE_PROX
|-
| PROJ_LAND_MINE_PLACED
|-
| PROJ_CONCUSSION
|-
| PROJ_CANNON
|-
| PROJ_MISSILE
|-
| PROJ_TURRET_BOLT
|-
| PROJ_REMOTE_BOLT
|-
| PROJ_EXP_BARREL
|-
| PROJ_HOMING_MISSILE
|-
| PROJ_PROBE_PROJ
|-
| PROJ_BOBAFETT_BALL
|}

=== <code>LogicSound</code> enum ===
{|
|-
| SND_ALERT
|-
| SND_PAIN
|-
| SND_DIE
|-
| SND_ATTACK1
|-
| SND_ATTACK2
|}

== Object Properties ==

=== sector ===
* Get only
* Gets the object's current sector (<code>Sector</code>)
* Usage example: <code>Sector troopSector = my_trooper.sector</code>

=== position ===
* Get or set
* Gets or sets the object's position (float3)
* Usage example: move the object to coordinates x20, y80, z-350
<pre>
myObj.position = {20, 80, -350};
</pre>

=== yaw ===
* Get or set
* Gets or sets the object's yaw (float)
* Usage example: <code>myObj.yaw = 120.0;</code>

=== radius ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.radius = 1.5;</code>

=== worldWidth ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

=== height ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.height = 9.5;</code>

=== worldHeight ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

== Object Methods ==

=== exists() ===
* Returns <code>true</code> if the object exists, otherwise returns <code>false</code>
* Usage example:
<pre>
Object trooper = level.getObject("stormtrooper3");

if (trooper.exists())
{
...
...
}
</pre>

Note: Scripting functions will internally do an ''exists'' check before being executed. Therefore it is not necessary for you to check that an object exists in ForceScript before calling methods on it. If you try to manipulate an object (eg. set its position) that doesn't exist, nothing will happen. If you ''get'' a property from a non-existent object, a default value will be returned (usually zero).

The <code>exists()</code> function in ForceScript enables you to check for an object's existence so that you can make your script logic conditional on an object's existence. For example, you may want your script to do something only if a certain enemy has been killed, or a certain item has been collected.

=== isPlayer() ===
* returns <code>true</code> if the object is the player, otherwise returns <code>false</code>

=== matchPosition(Object) ===
* moves the object to the same position as another object
* usage example:
<pre>
Object target = level.getObject("spirit7");
Object ds = level.getObject("deathstar_plans");

// move the death star plans to the same position as the spirit marker
ds.matchPosition(target);
</pre>

=== matchPosition(string) ===
* moves the object to the same position as another object by name
* usage example:
<pre>
// does the same as the above example, but uses the object's name
ds.matchPosition("spirit7");
</pre>

=== delete() ===
* Removes the object from the level
* usage example: <code>ewok2.delete();</code>

=== addLogic(string) ===
* Adds a logic to the object. Works with scenery, enemy logics, and pickup items. (Still to do: enable adding a custom logic.)
* usage example:
<pre>
// turn the table into scenery so it becomes breakable
table.addLogic("scenery");

// add Nava card logic to the object so it can now be picked up
navcard.addLogic("nava");

// add commando logic
com5.addLogic("commando");
</pre>

=== setCamera() ===
* Set the camera (EYE) to the object
* Usage example:
<pre>
Object cutsceneCam = level.getObject("camera9");
cutsceneCam.setCamera();
</pre>

=== sendMessage(MessageType) ===
* Sends a message to the object
* Parameter: <code>MessageType</code> enum

* Valid <code>MessageTypes</code> that can be sent to objects
** <code>WAKEUP</code> - if the object has an AI logic, this message will change it from idle state to alerted state (does not work on bosses)
** <code>CRUSH</code> - if the object has an AI logic, instantly kills it (does not work on bosses)

Usage example
<pre>
// Alerts the gamorrean guard
Object gamor = level.getObject("gamguard");
gamor.sendMessage(WAKEUP);
</pre>

Script Object

2025-09-26T06:41:16Z

Jerethk: /* Object Methods */

The '''Script Object''' API enables manipulation of objects via ForceScript.

== Naming of objects ==
TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names.

Objects are named in the .O file as shown here:

<pre>
/* 006 SEWERBUG.WAX */
CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: SEWER1
NAME: sewer-creature2
SEQEND

/* 007 REMOTE.WAX */
CLASS: SPRITE DATA: 2 X: 280.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: REMOTE
NAME: cool-remote
SEQEND

/* 008 MOUSEBOT.3DO */
CLASS: 3D DATA: 2 X: 256.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: MOUSEBOT
NAME: mouse4
SEQEND
</pre>

== Getting objects by name ==
To get objects by their name, use the methods in the [[Level_Script_API#Methods|Level Script]] API.
* <code>getObject</code>
* <code>getObjectsByName</code>

Once an object has been gotten by name, the script can do things with it.

Example:
<pre>
Object mb1 = level.getObject("mousebot1");

if (mb1.exists())
{
// Get the mousebot's position and move it eastwards by 20 units
float3 pos = mb1.position;
mb1.position = { pos.x + 20, pos.y, pos.z };
}

</pre>

== Object Properties ==

=== sector ===
* Get only
* Gets the object's current sector (<code>Sector</code>)
* Usage example: <code>Sector troopSector = my_trooper.sector</code>

=== position ===
* Get or set
* Gets or sets the object's position (float3)
* Usage example: move the object to coordinates x20, y80, z-350
<pre>
myObj.position = {20, 80, -350};
</pre>

=== yaw ===
* Get or set
* Gets or sets the object's yaw (float)
* Usage example: <code>myObj.yaw = 120.0;</code>

=== radius ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.radius = 1.5;</code>

=== worldWidth ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

=== height ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.height = 9.5;</code>

=== worldHeight ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

== Object Methods ==

=== exists() ===
* Returns <code>true</code> if the object exists, otherwise returns <code>false</code>
* Usage example:
<pre>
Object trooper = level.getObject("stormtrooper3");

if (trooper.exists())
{
...
...
}
</pre>

Note: Scripting functions will internally do an ''exists'' check before being executed. Therefore it is not necessary for you to check that an object exists in ForceScript before calling methods on it. If you try to manipulate an object (eg. set its position) that doesn't exist, nothing will happen. If you ''get'' a property from a non-existent object, a default value will be returned (usually zero).

The <code>exists()</code> function in ForceScript enables you to check for an object's existence so that you can make your script logic conditional on an object's existence. For example, you may want your script to do something only if a certain enemy has been killed, or a certain item has been collected.

=== isPlayer() ===
* returns <code>true</code> if the object is the player, otherwise returns <code>false</code>

=== matchPosition(Object) ===
* moves the object to the same position as another object
* usage example:
<pre>
Object target = level.getObject("spirit7");
Object ds = level.getObject("deathstar_plans");

// move the death star plans to the same position as the spirit marker
ds.matchPosition(target);
</pre>

=== matchPosition(string) ===
* moves the object to the same position as another object by name
* usage example:
<pre>
// does the same as the above example, but uses the object's name
ds.matchPosition("spirit7");
</pre>

=== delete() ===
* Removes the object from the level
* usage example: <code>ewok2.delete();</code>

=== addLogic(string) ===
* Adds a logic to the object. Works with scenery, enemy logics, and pickup items. (Still to do: enable adding a custom logic.)
* usage example:
<pre>
// turn the table into scenery so it becomes breakable
table.addLogic("scenery");

// add Nava card logic to the object so it can now be picked up
navcard.addLogic("nava");

// add commando logic
com5.addLogic("commando");
</pre>

=== setCamera() ===
* Set the camera (EYE) to the object
* Usage example:
<pre>
Object cutsceneCam = level.getObject("camera9");
cutsceneCam.setCamera();
</pre>

=== sendMessage(MessageType) ===
* Sends a message to the object
* Parameter: <code>MessageType</code> enum

* Valid <code>MessageTypes</code> that can be sent to objects
** <code>WAKEUP</code> - if the object has an AI logic, this message will change it from idle state to alerted state (does not work on bosses)
** <code>CRUSH</code> - if the object has an AI logic, instantly kills it (does not work on bosses)

Usage example
<pre>
// Alerts the gamorrean guard
Object gamor = level.getObject("gamguard");
gamor.sendMessage(WAKEUP);
</pre>

Script Elevator

2025-09-26T06:34:50Z

Jerethk: Created page with "== Properties == === master === * Get only * Return value: <code>true</code> if master is on, <code>false</code> if master is off === speed === * Get or set * Gets or sets the speed of an elevator"

== Properties ==

=== master ===
* Get only
* Return value: <code>true</code> if master is on, <code>false</code> if master is off

=== speed ===
* Get or set
* Gets or sets the speed of an elevator

Script Sector

2025-09-26T06:29:02Z

Jerethk: /* Methods */

== Properties ==

=== floorHeight ===
* Get or set

=== ceilHeight ===
* Get or set

=== secondHeight ===
* Get or set

=== ambient ===
* Get or set

=== wallCount ===
* Get only

=== floorTexture ===
* Get or set

=== ceilTexture ===
* Get or set

=== floorTextureOffset ===
* Get or set

=== ceilTextureOffset ===
* Get or set

== Methods ==

=== isValid() ===

=== isFlagSet(int, uint) ===

=== clearFlag(int, uint) ===

=== setFlag(int, uint) ===

=== getCenterXZ() ===

=== getWall(int) ===

=== sendMessage(MessageType) ===
* Sends a message to sector
* Parameters: <code>MessageType</code> enum
* Return value: void

* Valid <code>MessageTypes</code> that can be sent to sectors:
** <code>M_TRIGGER</code>
** <code>NEXT_STOP</code>
** <code>PREV_STOP</code>
** <code>WAKEUP</code>
** <code>MASTER_ON</code>
** <code>MASTER_OFF</code>

Usage example:
<pre>
Sector myElev = level.getSector("elev1");
myElev.sendMessage(NEXT_STOP);
</pre>

=== sendMessage(MessageType, uint) ===
* Sends a message to sector with an event
* Parameters: <code>MessageType</code> enum, event
* Return value: void

* Valid <code>MessageTypes</code> are as above.

Usage example:
<pre>
Sector myElev = level.getSector("elev1");
myElev.sendMessage(NEXT_STOP, 131072);
</pre>

This is the equivalent of sending a message via INF like this - <code>message: 1 elev1 NEXT_STOP 131072</code>

Script Sector

2025-09-26T06:15:02Z

Jerethk: Created page with "== Properties == === floorHeight === * Get or set === ceilHeight === * Get or set === secondHeight === * Get or set === ambient === * Get or set === wallCount === * Get only === floorTexture === * Get or set === ceilTexture === * Get or set === floorTextureOffset === * Get or set === ceilTextureOffset === * Get or set == Methods == === isValid() === === isFlagSet(int, uint) === === clearFlag(int, uint) === === setFlag(int, uint) === === getCenterXZ() ===..."

Camera feature

2025-09-02T12:15:25Z

Jerethk:

In vanilla Dark Forces, the camera ("EYE") is usually attached to the same object as the PLAYER, meaning that the level is viewed from the perspective of the player. It is possible for the camera to be placed on a non-player object, allowing for a third-person rather than first-person experience -- this is exploited in some mods (eg. Dark Tide, Enter the Kell Dragon).

TFE now allows the camera to be moved to a different object at any time during gameplay. This allows for various effects such as
* Being able to look through security cameras
* Better in-game "cutscenes" / cinematic sequences
* The ability to switch between first-person and third-person perspectives

See also: [[VUE Camera transforms]]

There are two ways to move the camera: via INF, or via ForceScript.

The camera (Eye) can be moved to any kind of object: a Spirit (invisible), an enemy, a scenery, a 3DO, etc. Be warned that if the object is destroyed while the camera is on it (eg. the enemy is killed) the game will crash.

== Moving the camera with INF ==
The first step is to designate an object as a camera. This is done in the O file by using the new keyword <code>CAMERA</code> as follows.

<pre>
CLASS: 3D DATA: 0 X: 160.00 Y: -18.00 Z: 332.00 PCH: -25.00 YAW: 90.00 ROL: 0.00 DIFF: 1
SEQ
CAMERA
SEQEND
</pre>

A new CAMERA message has been added to INF. It can be sent the same way as other messages, either from a trigger or from an elevator stop. The following example shows it being sent from a trigger.

<pre>
item: line name: room1 num: 2
seq
class: trigger standard
event_mask: 16
client: camsec2
message: CAMERA
seqend
</pre>

When the message is sent:
* If the camera is currently on the player, the game will search the target sector ("camsec2" in this example) for a camera object. When it finds one, it will move the camera to that object. If no camera object is found in the target sector, nothing will happen.
* If the camera is currently ''not'' on the player, the camera will be moved back to the player.

== Moving the camera with ForceScript ==
To move the camera to an object with ForceScript, call the <code>setCamera()</code> function on that object.

<pre>
myobject.setCamera();
</pre>

To move the camera to the player, call <code>setCamera()</code> on the player.

<pre>
player.setCamera();
</pre>

== Freezing the player ==
When the camera is not on the player, the player can ordinarily still move around, jump, shoot and so on. It might be desirable (eg. during a cutscene) to freeze the player's movement while the camera is somewhere else.

To do this, the <code>disableActions()</code> and <code>enableActions()</code> functions from the [[Player_Script_API#Methods|Player Script API]] can be used.

== Other player actions ==
Night vision goggles are automatically disabled when the camera is not on the player.

Gas mask and headlamp are still usable when the camera is not on the player, and will continue to drain battery. (Headlamp light will not be visible.)

The player will still take damage and can be killed while the camera is somewhere else. If the player dies while the camera is somewhere else, the camera will be reset to the player when he respawns.

== Enemy behaviour ==
As per default Dark Forces behaviour, enemies will shoot towards the camera (EYE) instead of the player. This is something that might be changed at a later point.

Camera feature

2025-09-02T12:12:42Z

Jerethk:

Camera feature

2025-09-02T12:06:25Z

Jerethk: Move with ForceScript

Camera feature

2025-09-02T11:55:06Z

Jerethk: Move by INF

VUE Camera transforms

2025-09-02T11:39:10Z

Jerethk:

Dark Forces has built-in support for transforming a camera's location and orientation with '''VUE files'''. This functionality was "discovered" when the source code was reverse engineered.

The camera in DF is normally called the "EYE object". The EYE (camera) is assigned to an object at level startup and is normally assigned to the PLAYER object, but this is not mandatory, and there are a few mods which exploit the possibility of separate PLAYER and EYE objects.

Vanilla Dark Forces does not support moving the EYE (camera) from one object to another object after level load, but [[Camera feature|this can be done in The Force Engine]].

=== How to use ===
In a VUE file, each keyframe for the camera has the following syntax:

<code>camera [x-pos] [z-pos] [y-pos] [x-target] [z-target] [y-target] [roll] [lens]</code>

* <code>x-pos z-pos y-pos</code> are the location (absolute) of the camera in the map
* <code>x-target z-target y-target</code> are the coordinates where the camera is pointing at. The camera's yaw and pitch orientation are calculated from the vector between the camera's location and its target.
* <code>roll</code> is the camera's roll (note: rolling of the camera is not supported by DF's renderer; no matter what number is set here, the scene will always be rendered with a roll of 0)
* <code>lens</code> is presumably meant to be a zoom factor, which is not used by the DF engine.

Examples of camera instructions can be seen in the VUE files used for the original Gromas and Detention levels.

'''Note:''' Vanilla DF did not calculate the camera's pitch, therefore pitch will always be set at 0. In The Force Engine, the code has been amended to calculate the pitch.

=== O file ===
The camera object needs to be given the following code in the level's O file.

<pre>
LOGIC: KEY
VUE: filename.VUE camera
</pre>

Camera feature

2025-09-02T11:38:07Z

Jerethk: Created page with "In vanilla Dark Forces, the camera ("EYE") is usually attached to the same object as the PLAYER, meaning that the level is viewed from the perspective of the player. It is possible for the camera to be placed on a non-player object, allowing for a third-person rather than first-person experience -- this is exploited in some mods (eg. Dark Tide, Enter the Kell Dragon). TFE now allows the camera to be moved to a different object at any time during gameplay. This allows fo..."

Dark Forces Wiki

2025-09-02T11:26:07Z

Jerethk: /* The Force Engine Reference */

<div style="text-align: center; font-size: x-large; padding: 1em;">[[File:WikiLogo.png|center|frameless|561x561px]]'''Welcome to the {{SITENAME}}!'''</div>

This community is dedicated to the 1995 game ''Star Wars: Dark Forces'' with an emphasis on modding and map making .

If you would like to contribute please create an account and help expand this wiki.

=== Dark Forces Editors ===

# '''[[WDFUSE]]''' - ('''The original Dark Forces Editor)'''
# '''[[TFE-EDITOR]]''' - '''(The Force Engine Editor)'''
# '''[https://df-21.net/downloads/utilities.php CYBERDARK] - (Obsolete)'''

=== How To Guides ===
* [https://df-21.net/wiki/?title=DF-21_Mission_Components Submitting DF-21 Missions]
* [https://df-21.net/wiki/?title=Converting_Classic_Maps Converting Old DF-21 Missions]
* [https://df-21.net/wiki/?title=How_To:_Good_MIDI How to get good sounding MIDI in Dark Forces]
* [https://df-21.net/wiki/?title=WAX_File_Generator How to generate an Enemy WAX file with Blender]]
* [https://df-21.net/wiki/?title=Blender_3DO_Guide How to create a 3DO file with Blender]]
* [[Level creation tips]]

=== Dark Forces Reference ===
* [[Dark Forces Unofficial Specifications]]
* [[Dark Forces Remaster Unofficial Specs]]
* [[Teleporter Basic]]
* [[VUE Camera transforms]]
* [[Logics and AI reference]]
* [[Weapons reference]]

=== The Force Engine Reference ===
* [[TFE_Mod_Overrides|Mod Overrides with MOD_CONF]]
* [[TFE Custom Logics]]
* [[TFE Projectile Data]]
* [[TFE Pickup Data]]
* [[TFE Weapon Data]]
* [[Camera feature]]

==== TFE Scripting ====
* [[TFE Level Script]]
* [[Math Script API]]
* [[System Script API]]
* [[Level Script API]]
* [[Game Script API]]
* [[Player Script API]]

* [[Script Sector]]
* [[Script Wall]]
* [[Script Object]]
* [[Script Texture]]
* [[Script Elevator]]

=== Vault ===
* [[:Category:Demo Assets|Assets included with the Dark Forces demo]]

[[Category:{{SITENAME}}]]

TFE Custom Logics

2025-09-02T11:19:34Z

Jerethk: /* Data properties */

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.

To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

=== JSON locations ===
Custom logics are defined in JSON files. TFE will search for and load logics from all logic .JSON files found in these locations

* DARK\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.

In addition, if you are running a Mod from a ZIP, TFE will look for a <code>\Logics</code> subfolder inside the ZIP and load logics from any .JSON files found there.

Logics loaded from a Mod will take preference over any logics found in other locations that have the same name.

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 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 ===
A logic JSON should consist of a single array called "logics".

Each element of the "logics" array must consist of two items, in this order
* "logicName" - a string which is the name of the logic
* "data" - an object containing properties that are set for the logic

Example:
<pre>
{
"logics": [
{
"logicName": "LogicA",
"data": {
"alertSound": "alert1.voc",
"painSound": "pain1.voc",
"hitpoints": 25,
"projectile": "rifle_bolt"
}
},
{
"logicName": "LogicB",
"data": {
"alertSound": "alert2.voc",
"painSound": "pain2.voc",
"hitpoints": 39,
"speed": 20,
"projectile": "thermal_det",
"dropItem": "red_key"
}
}
]
}
</pre>

Logic JSONs are ''not'' case sensitive. The text inside the JSON can be all uppercase, all lowercase, or any mix of upper and lowercase; it will all be read the same.

For example, "alertsound", "ALERTSOUND", "AlertSound", "alertSound" will all be accepted.

Further tips about getting the JSON format right can be found on the [[TFE Mod Overrides#How_do_I_create_or_edit_a_MOD_CONF.txt_file_and_what_is_JSON?|TFE MOD Overrides]] article.

=== Data properties ===
Here is a list of the properties that you can set for each logic. They are all standard JSON key-value pairs.

You do not need to set every property. Unset properties will default to the values shown.

Properties can be listed in any order. Property names are not case sensitive, but need to be spelled correctly.

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| hasGravity || boolean || <code>true</code> || If true, will be affected by gravity
|-
| isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
|-
| fieldOfView || number (integer) || 210 || Field of view, in degrees. If set to 360, the enemy will be able to see you even if you are standing behind it.
|-
| awareRange || number (integer) || 20 || If you are within this distance from the enemy (in DFU), it will be alerted even if you are outside its field of view. (However, this can be affected by other things, such as the ambient light.)
|-
| 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
|-
| attack1Sound || string || ''no sound'' || VOC file to play for primary attack
|-
| attack2Sound || string || ''no sound'' || VOC file to play for secondary attack
|-
| hitPoints || number (integer) || 4 || Hitpoints. The enemy will die when it reaches 0.
|-
| dropItem || string or number || -1 (nothing) || What item is dropped 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. (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.
|-
| hasRangedAttack || boolean || <code>true</code> || If true, the enemy will have a ranged attack. If the enemy has a melee attack, the ranged attack will be the secondary attack. If it does not have a melee attack, the ranged attack will be the primary attack.
|-
| litWithMeleeAttack || boolean || <code>false</code> || If true, the sprite will light up when it attacks with melee.
|-
| litWithRangedAttack || boolean || <code>true</code> || If true, the sprite will light up when it does its ranged attack.
|-
| projectile || string or number || <code>"rifle_bolt"</code> || What projectile the enemy will fire for its ranged attack. See reference table below for options.
|-
| wanderTime || number (integer) || 300 || How long (in seconds) the enemy will keep looking for the player, before it returns to its idle or "asleep" state. This time is reset when the enemy is re-alerted by the player.
|-
| rangedAttackDelay || number (decimal) || 2 || Time delay in seconds between range attacks (the game engine adds some variability to this)
|-
| meleeAttackDelay || number (decimal) || 0 || Time delay in seconds between melee attacks
|-
| meleeRange || number (integer) || 0 || Range (in DFU) of melee attack - how far the player can be from the enemy to be hit by it.
|-
| meleeDamage || number (integer) || 0 || Damage that each melee attack will inflict.
|-
| minAttackDist || number (integer) || 0 || Minimum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| maxAttackDist || number (integer) || 160 || Maximum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| 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.
|-
| verticalSpeed || number (integer) || 10 || For flying enemies only, this is their vertical speed.
|-
| 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)
|}

=== Using custom logics ===
Logics that you have defined in JSON can be applied to a sprite in the .O file in the same way as other (hardcoded) enemy logics. For example, if you have the following logic

<pre>
"logicName": "Rodian",
"data": {
"alertSound": "rodian1.voc",
....
}
</pre>

Apply it to a sprite (WAX) like this, and then the sprite should behave with the custom logic.

<pre>
SEQ
LOGIC: Rodian
SEQEND
</pre>

You can also use JSON-defined logics with generators, for example

<pre>
SEQ
LOGIC: GENERATOR Rodian
DELAY: 10
INTERVAL: 5
NUM_TERMINATE: 6
MAX_ALIVE: 1
MAX_DIST: 800
MIN_DIST: 50
SEQEND
</pre>

'''Important''': If a level with a custom logic is run with vanilla Dark Forces or the Dark Forces Remaster, the sprites will be "lifeless". However, if the level has generators with a custom logic, this causes the original game to crash.

=== Overriding hardcoded logics ===
You ''can'' override hardcoded logics by creating a JSON logic with the same name as one of the hardcoded logics. For example, <code>storm1</code> and <code>commando</code>.

If you override a boss logic, like <code>kell</code> or one of the dark troopers, the enemy will behave like an ordinary enemy instead of a boss; they will lose their ability to trigger the BOSS elevator when they die.

=== Custom logics and WAX files ===
A custom logic's behaviours/actions will correspond to WAX animations as follows

{| border=1 cellpadding=6px
|-
| 0 || Walking / moving
|-
| 1 || Primary attack
|-
| 2 || Melee death
|-
| 3 || Shooting / explosion death
|-
| 4 || Dead
|-
| 5 || Idle / stationary
|-
| 6 || Primary attack conclusion (eg. recoil)
|-
| 7 || Secondary attack
|-
| 8 || Secondary attack conclusion
|-
| 9 || ''unused''
|-
| 10 || ''unused''
|-
| 11 || ''unused''
|-
| 12 || Pain
|}

This follows the same pattern as all the standard Dark Forces enemies.

Note that if a logic has a melee attack, this will always be the primary attack (animations 1 and 6). If a logic has ''only'' a ranged attack, then this will be the primary attack (animations 1 and 6). If a logic has both melee and ranged attacks, the melee will be primary (animations 1 and 6) and the ranged attack will be secondary (animations 7 and 8).

=== Reference ===
==== Projectile list ====
You can assign projectiles with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a projectile
|-
| 0 || <code>punch</code> || This is a special projectile used for the player's fists, and may not work with logics
|-
| 1 || <code>pistol_bolt</code>
|-
| 2 || <code>rifle_bolt</code>
|-
| 3 || <code>thermal_det</code>
|-
| 4 || <code>repeater</code>
|-
| 5 || <code>plasma</code> || Fusion cutter projectile
|-
| 6 || <code>mortar</code>
|-
| 7 || <code>land_mine</code>
|-
| 8 || <code>land_mine_prox</code> || Proximity land mine
|-
| 9 || <code>land_mine_placed</code>
|-
| 10 || <code>concussion</code>
|-
| 11 || <code>cannon</code>
|-
| 12 || <code>missile</code>
|-
| 13 || <code>turret_bolt</code>
|-
| 14 || <code>remote_bolt</code>
|-
| 15 || <code>exp_barrel</code> || An invisible projectile that is normally spawned when a barrel explodes
|-
| 16 || <code>homing_missile</code> || Mohc's homing missiles
|-
| 17 || <code>probe_proj</code> || Green interrogator droid projectile
|-
| 18 || <code>bobafett_ball</code> || Boba Fett's missiles
|}

==== Drop item list ====
You can assign drop items with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not drop anything when they die
|-
| 0 || <code>PLANS</code> || Death Star plans
|-
| 1 || <code>PHRIK</code>
|-
| 2 || <code>NAVA</code>
|-
| 3 || <code>DT_WEAPON</code>
|-
| 4 || <code>DATATAPE</code>
|-
| 5 || <code>RIFLE</code>
|-
| 6 || <code>AUTOGUN</code>
|-
| 7 || <code>MORTAR</code>
|-
| 8 || <code>FUSION</code>
|-
| 9 || <code>CONCUSSION</code>
|-
| 10 || <code>CANNON</code>
|-
| 11 || <code>ENERGY</code>
|-
| 12 || <code>POWER</code>
|-
| 13 || <code>PLASMA</code>
|-
| 14 || <code>DETONATOR</code>
|-
| 15 || <code>DETONATORS</code>
|-
| 16 || <code>SHELL</code> || Mortar shell
|-
| 17 || <code>SHELLS</code>
|-
| 18 || <code>MINE</code>
|-
| 19 || <code>MINES</code>
|-
| 20 || <code>MISSILE</code>
|-
| 21 || <code>MISSILES</code>
|-
| 22 || <code>SHIELD</code>
|-
| 23 || <code>RED_KEY</code>
|-
| 24 || <code>YELLOW_KEY</code>
|-
| 25 || <code>BLUE_KEY</code>
|-
| 26 || <code>GOGGLES</code>
|-
| 27 || <code>CLEATS</code>
|-
| 28 || <code>MASK</code> || Gas mask
|-
| 29 || <code>BATTERY</code>
|-
| 30 || <code>CODE1</code>
|-
| 31 || <code>CODE2</code>
|-
| 32 || <code>CODE3</code>
|-
| 33 || <code>CODE4</code>
|-
| 34 || <code>CODE5</code>
|-
| 35 || <code>CODE6</code>
|-
| 36 || <code>CODE7</code>
|-
| 37 || <code>CODE8</code>
|-
| 38 || <code>CODE9</code>
|-
| 39 || <code>INVINCIBLE</code> || Shield supercharge
|-
| 40 || <code>SUPERCHARGE</code> || Weapon supercharge
|-
| 41 || <code>REVIVE</code>
|-
| 42 || <code>LIFE</code>
|-
| 43 || <code>MEDKIT</code>
|-
| 44 || <code>PILE</code> || Kyle's pile of weapons
|}

==== Death effect list ====
You can assign death effects with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

Note that some effects inflict damage.

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a death effect
|-
| 0 || <code>SMALL_EXP</code> || small "puff" - blaster weapons
|-
| 1 || <code>THERMDET_EXP</code> || thermal detonator explosion
|-
| 2 || <code>PLASMA_EXP</code> || Green plasma "puff"
|-
| 3 || <code>MORTAR_EXP</code> || mortar explosion
|-
| 4 || <code>CONCUSSION</code> || concussion - first stage
|-
| 5 || <code>CONCUSSION2</code> || concussion - second stage
|-
| 6 || <code>MISSILE_EXP</code> || missile explosion
|-
| 7 || <code>MISSILE_WEAK</code> || weaker version of the missle explosion
|-
| 8 || <code>PUNCH</code> || punch
|-
| 9 || <code>CANNON_EXP</code> || Blue cannon "puff"
|-
| 10 || <code>REPEATER_EXP</code> || repeater "puff"
|-
| 11 || <code>LARGE_EXP</code> || Land mine explosion
|-
| 12 || <code>EXP_BARREL</code> || exploding barrel
|-
| 13 || <code>EXP_INVIS</code> || an explosion that makes no sound and has no visual effect
|-
| 14 || <code>SPLASH</code> || water splash
|-
| 15 || <code>EXP_35</code> || medium explosion, 35 damage (used for probe droid death)
|-
| 16 || <code>EXP_NO_DMG</code> || medium explosion, no damage (used for turret and welder deaths)
|-
| 17 || <code>EXP_25</code> || medium explosion, 25 damage (used for Boba Fett missile explosions)
|}

TFE Custom Logics

2025-09-02T11:16:19Z

Jerethk: Add new properties

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.

To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

=== JSON locations ===
Custom logics are defined in JSON files. TFE will search for and load logics from all logic .JSON files found in these locations

* DARK\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.

In addition, if you are running a Mod from a ZIP, TFE will look for a <code>\Logics</code> subfolder inside the ZIP and load logics from any .JSON files found there.

Logics loaded from a Mod will take preference over any logics found in other locations that have the same name.

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 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 ===
A logic JSON should consist of a single array called "logics".

Each element of the "logics" array must consist of two items, in this order
* "logicName" - a string which is the name of the logic
* "data" - an object containing properties that are set for the logic

Example:
<pre>
{
"logics": [
{
"logicName": "LogicA",
"data": {
"alertSound": "alert1.voc",
"painSound": "pain1.voc",
"hitpoints": 25,
"projectile": "rifle_bolt"
}
},
{
"logicName": "LogicB",
"data": {
"alertSound": "alert2.voc",
"painSound": "pain2.voc",
"hitpoints": 39,
"speed": 20,
"projectile": "thermal_det",
"dropItem": "red_key"
}
}
]
}
</pre>

Logic JSONs are ''not'' case sensitive. The text inside the JSON can be all uppercase, all lowercase, or any mix of upper and lowercase; it will all be read the same.

For example, "alertsound", "ALERTSOUND", "AlertSound", "alertSound" will all be accepted.

Further tips about getting the JSON format right can be found on the [[TFE Mod Overrides#How_do_I_create_or_edit_a_MOD_CONF.txt_file_and_what_is_JSON?|TFE MOD Overrides]] article.

=== Data properties ===
Here is a list of the properties that you can set for each logic. They are all standard JSON key-value pairs.

You do not need to set every property. Unset properties will default to the values shown.

Properties can be listed in any order. Property names are not case sensitive, but need to be spelled correctly.

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| hasGravity || boolean || <code>true</code> || If true, will be affected by gravity
|-
| isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
|-
| fieldOfView || number (integer) || 210 || Field of view, in degrees. If set to 360, the enemy will be able to see you even if you are standing behind it.
|-
| awareRange || number (integer) || 20 || If you are within this distance from the enemy (in DFU), it will be alerted even if you are outside its field of view. (However, this can be affected by other things, such as the ambient light.)
|-
| 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
|-
| attack1Sound || string || ''no sound'' || VOC file to play for primary attack
|-
| attack2Sound || string || ''no sound'' || VOC file to play for secondary attack
|-
| hitPoints || number (integer) || 4 || Hitpoints. The enemy will die when it reaches 0.
|-
| dropItem || string or number || -1 (nothing) || What item is dropped 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.
|-
| hasRangedAttack || boolean || <code>true</code> || If true, the enemy will have a ranged attack. If the enemy has a melee attack, the ranged attack will be the secondary attack. If it does not have a melee attack, the ranged attack will be the primary attack.
|-
| litWithMeleeAttack || boolean || <code>false</code> || If true, the sprite will light up when it attacks with melee.
|-
| litWithRangedAttack || boolean || <code>true</code> || If true, the sprite will light up when it does its ranged attack.
|-
| projectile || string or number || <code>"rifle_bolt"</code> || What projectile the enemy will fire for its ranged attack. See reference table below for options.
|-
| wanderTime || number (integer) || 300 || How long (in seconds) the enemy will keep looking for the player, before it returns to its idle or "asleep" state. This time is reset when the enemy is re-alerted by the player.
|-
| rangedAttackDelay || number (decimal) || 2 || Time delay in seconds between range attacks (the game engine adds some variability to this)
|-
| meleeAttackDelay || number (decimal) || 0 || Time delay in seconds between melee attacks
|-
| meleeRange || number (integer) || 0 || Range (in DFU) of melee attack - how far the player can be from the enemy to be hit by it.
|-
| meleeDamage || number (integer) || 0 || Damage that each melee attack will inflict.
|-
| minAttackDist || number (integer) || 0 || Minimum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| maxAttackDist || number (integer) || 160 || Maximum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| 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.
|-
| verticalSpeed || number (integer) || 10 || For flying enemies only, this is their vertical speed.
|-
| 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)
|}

=== Using custom logics ===
Logics that you have defined in JSON can be applied to a sprite in the .O file in the same way as other (hardcoded) enemy logics. For example, if you have the following logic

<pre>
"logicName": "Rodian",
"data": {
"alertSound": "rodian1.voc",
....
}
</pre>

Apply it to a sprite (WAX) like this, and then the sprite should behave with the custom logic.

<pre>
SEQ
LOGIC: Rodian
SEQEND
</pre>

You can also use JSON-defined logics with generators, for example

<pre>
SEQ
LOGIC: GENERATOR Rodian
DELAY: 10
INTERVAL: 5
NUM_TERMINATE: 6
MAX_ALIVE: 1
MAX_DIST: 800
MIN_DIST: 50
SEQEND
</pre>

'''Important''': If a level with a custom logic is run with vanilla Dark Forces or the Dark Forces Remaster, the sprites will be "lifeless". However, if the level has generators with a custom logic, this causes the original game to crash.

=== Overriding hardcoded logics ===
You ''can'' override hardcoded logics by creating a JSON logic with the same name as one of the hardcoded logics. For example, <code>storm1</code> and <code>commando</code>.

If you override a boss logic, like <code>kell</code> or one of the dark troopers, the enemy will behave like an ordinary enemy instead of a boss; they will lose their ability to trigger the BOSS elevator when they die.

=== Custom logics and WAX files ===
A custom logic's behaviours/actions will correspond to WAX animations as follows

{| border=1 cellpadding=6px
|-
| 0 || Walking / moving
|-
| 1 || Primary attack
|-
| 2 || Melee death
|-
| 3 || Shooting / explosion death
|-
| 4 || Dead
|-
| 5 || Idle / stationary
|-
| 6 || Primary attack conclusion (eg. recoil)
|-
| 7 || Secondary attack
|-
| 8 || Secondary attack conclusion
|-
| 9 || ''unused''
|-
| 10 || ''unused''
|-
| 11 || ''unused''
|-
| 12 || Pain
|}

This follows the same pattern as all the standard Dark Forces enemies.

Note that if a logic has a melee attack, this will always be the primary attack (animations 1 and 6). If a logic has ''only'' a ranged attack, then this will be the primary attack (animations 1 and 6). If a logic has both melee and ranged attacks, the melee will be primary (animations 1 and 6) and the ranged attack will be secondary (animations 7 and 8).

=== Reference ===
==== Projectile list ====
You can assign projectiles with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a projectile
|-
| 0 || <code>punch</code> || This is a special projectile used for the player's fists, and may not work with logics
|-
| 1 || <code>pistol_bolt</code>
|-
| 2 || <code>rifle_bolt</code>
|-
| 3 || <code>thermal_det</code>
|-
| 4 || <code>repeater</code>
|-
| 5 || <code>plasma</code> || Fusion cutter projectile
|-
| 6 || <code>mortar</code>
|-
| 7 || <code>land_mine</code>
|-
| 8 || <code>land_mine_prox</code> || Proximity land mine
|-
| 9 || <code>land_mine_placed</code>
|-
| 10 || <code>concussion</code>
|-
| 11 || <code>cannon</code>
|-
| 12 || <code>missile</code>
|-
| 13 || <code>turret_bolt</code>
|-
| 14 || <code>remote_bolt</code>
|-
| 15 || <code>exp_barrel</code> || An invisible projectile that is normally spawned when a barrel explodes
|-
| 16 || <code>homing_missile</code> || Mohc's homing missiles
|-
| 17 || <code>probe_proj</code> || Green interrogator droid projectile
|-
| 18 || <code>bobafett_ball</code> || Boba Fett's missiles
|}

==== Drop item list ====
You can assign drop items with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not drop anything when they die
|-
| 0 || <code>PLANS</code> || Death Star plans
|-
| 1 || <code>PHRIK</code>
|-
| 2 || <code>NAVA</code>
|-
| 3 || <code>DT_WEAPON</code>
|-
| 4 || <code>DATATAPE</code>
|-
| 5 || <code>RIFLE</code>
|-
| 6 || <code>AUTOGUN</code>
|-
| 7 || <code>MORTAR</code>
|-
| 8 || <code>FUSION</code>
|-
| 9 || <code>CONCUSSION</code>
|-
| 10 || <code>CANNON</code>
|-
| 11 || <code>ENERGY</code>
|-
| 12 || <code>POWER</code>
|-
| 13 || <code>PLASMA</code>
|-
| 14 || <code>DETONATOR</code>
|-
| 15 || <code>DETONATORS</code>
|-
| 16 || <code>SHELL</code> || Mortar shell
|-
| 17 || <code>SHELLS</code>
|-
| 18 || <code>MINE</code>
|-
| 19 || <code>MINES</code>
|-
| 20 || <code>MISSILE</code>
|-
| 21 || <code>MISSILES</code>
|-
| 22 || <code>SHIELD</code>
|-
| 23 || <code>RED_KEY</code>
|-
| 24 || <code>YELLOW_KEY</code>
|-
| 25 || <code>BLUE_KEY</code>
|-
| 26 || <code>GOGGLES</code>
|-
| 27 || <code>CLEATS</code>
|-
| 28 || <code>MASK</code> || Gas mask
|-
| 29 || <code>BATTERY</code>
|-
| 30 || <code>CODE1</code>
|-
| 31 || <code>CODE2</code>
|-
| 32 || <code>CODE3</code>
|-
| 33 || <code>CODE4</code>
|-
| 34 || <code>CODE5</code>
|-
| 35 || <code>CODE6</code>
|-
| 36 || <code>CODE7</code>
|-
| 37 || <code>CODE8</code>
|-
| 38 || <code>CODE9</code>
|-
| 39 || <code>INVINCIBLE</code> || Shield supercharge
|-
| 40 || <code>SUPERCHARGE</code> || Weapon supercharge
|-
| 41 || <code>REVIVE</code>
|-
| 42 || <code>LIFE</code>
|-
| 43 || <code>MEDKIT</code>
|-
| 44 || <code>PILE</code> || Kyle's pile of weapons
|}

==== Death effect list ====
You can assign death effects with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

Note that some effects inflict damage.

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a death effect
|-
| 0 || <code>SMALL_EXP</code> || small "puff" - blaster weapons
|-
| 1 || <code>THERMDET_EXP</code> || thermal detonator explosion
|-
| 2 || <code>PLASMA_EXP</code> || Green plasma "puff"
|-
| 3 || <code>MORTAR_EXP</code> || mortar explosion
|-
| 4 || <code>CONCUSSION</code> || concussion - first stage
|-
| 5 || <code>CONCUSSION2</code> || concussion - second stage
|-
| 6 || <code>MISSILE_EXP</code> || missile explosion
|-
| 7 || <code>MISSILE_WEAK</code> || weaker version of the missle explosion
|-
| 8 || <code>PUNCH</code> || punch
|-
| 9 || <code>CANNON_EXP</code> || Blue cannon "puff"
|-
| 10 || <code>REPEATER_EXP</code> || repeater "puff"
|-
| 11 || <code>LARGE_EXP</code> || Land mine explosion
|-
| 12 || <code>EXP_BARREL</code> || exploding barrel
|-
| 13 || <code>EXP_INVIS</code> || an explosion that makes no sound and has no visual effect
|-
| 14 || <code>SPLASH</code> || water splash
|-
| 15 || <code>EXP_35</code> || medium explosion, 35 damage (used for probe droid death)
|-
| 16 || <code>EXP_NO_DMG</code> || medium explosion, no damage (used for turret and welder deaths)
|-
| 17 || <code>EXP_25</code> || medium explosion, 25 damage (used for Boba Fett missile explosions)
|}

Script Object

2025-09-02T10:24:20Z

Jerethk: setCamera

The '''Script Object''' API enables manipulation of objects via ForceScript.

== Naming of objects ==
TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names.

Objects are named in the .O file as shown here:

<pre>
/* 006 SEWERBUG.WAX */
CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: SEWER1
NAME: sewer-creature2
SEQEND

/* 007 REMOTE.WAX */
CLASS: SPRITE DATA: 2 X: 280.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: REMOTE
NAME: cool-remote
SEQEND

/* 008 MOUSEBOT.3DO */
CLASS: 3D DATA: 2 X: 256.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: MOUSEBOT
NAME: mouse4
SEQEND
</pre>

== Getting objects by name ==
To get objects by their name, use the methods in the [[Level_Script_API#Methods|Level Script]] API.
* <code>getObject</code>
* <code>getObjectsByName</code>

Once an object has been gotten by name, the script can do things with it.

Example:
<pre>
Object mb1 = level.getObject("mousebot1");

if (mb1.exists())
{
// Get the mousebot's position and move it eastwards by 20 units
float3 pos = mb1.position;
mb1.position = { pos.x + 20, pos.y, pos.z };
}

</pre>

== Object Properties ==

=== sector ===
* Get only
* Gets the object's current sector (<code>Sector</code>)
* Usage example: <code>Sector troopSector = my_trooper.sector</code>

=== position ===
* Get or set
* Gets or sets the object's position (float3)
* Usage example: move the object to coordinates x20, y80, z-350
<pre>
myObj.position = {20, 80, -350};
</pre>

=== yaw ===
* Get or set
* Gets or sets the object's yaw (float)
* Usage example: <code>myObj.yaw = 120.0;</code>

=== radius ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.radius = 1.5;</code>

=== worldWidth ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

=== height ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.height = 9.5;</code>

=== worldHeight ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

== Object Methods ==

=== exists() ===
* Returns <code>true</code> if the object exists, otherwise returns <code>false</code>
* Usage example:
<pre>
Object trooper = level.getObject("stormtrooper3");

if (trooper.exists())
{
...
...
}
</pre>

Note: Scripting functions will internally do an ''exists'' check before being executed. Therefore it is not necessary for you to check that an object exists in ForceScript before calling methods on it. If you try to manipulate an object (eg. set its position) that doesn't exist, nothing will happen. If you ''get'' a property from a non-existent object, a default value will be returned (usually zero).

The <code>exists()</code> function in ForceScript enables you to check for an object's existence so that you can make your script logic conditional on an object's existence. For example, you may want your script to do something only if a certain enemy has been killed, or a certain item has been collected.

=== isPlayer() ===
* returns <code>true</code> if the object is the player, otherwise returns <code>false</code>

=== matchPosition(Object) ===
* moves the object to the same position as another object
* usage example:
<pre>
Object target = level.getObject("spirit7");
Object ds = level.getObject("deathstar_plans");

// move the death star plans to the same position as the spirit marker
ds.matchPosition(target);
</pre>

=== matchPosition(string) ===
* moves the object to the same position as another object by name
* usage example:
<pre>
// does the same as the above example, but uses the object's name
ds.matchPosition("spirit7");
</pre>

=== delete() ===
* Removes the object from the level
* usage example: <code>ewok2.delete();</code>

=== addLogic(string) ===
* Adds a logic to the object. Works with scenery, enemy logics, and pickup items. (Still to do: enable adding a custom logic.)
* usage example:
<pre>
// turn the table into scenery so it becomes breakable
table.addLogic("scenery");

// add Nava card logic to the object so it can now be picked up
navcard.addLogic("nava");

// add commando logic
com5.addLogic("commando");
</pre>

=== setCamera() ===
* Set the camera (EYE) to the object
* Usage example:
<pre>
Object cutsceneCam = level.getObject("camera9");
cutsceneCam.setCamera();
</pre>

Player Script API

2025-09-02T10:21:10Z

Jerethk: setCamera

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerAction</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

=== disabledActions ===
* Get the player actions that have currently been disabled
* Usage example: check if firing has been disabled
<pre>
if (player.disabledActions & ACTION_FIRE)
{
// firing has been disabled
}
</pre>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== setCamera() ===
* Move the camera (EYE) to the player
* Usage: <code>player.setCamera();</code>

=== disableActions(PlayerActions) ===
* Disable the player's actions
* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: disable player's movement and weapon firing
<pre>
player.disableActions(ACTION_MOVE | ACTION_FIRE);
</pre>

Disable all actions (movement, rotation and firing)
<pre>
player.disableActions(ACTION_ALL);
</pre>

=== enableActions(PlayerActions) ===
* Enable the player's actions if they have been disabled
* Parameter: actions to enable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: enable player's movement and rotation
<pre>
player.enableActions(ACTION_MOVE | ACTION_ROTATE);
</pre>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

TFE Custom Logics

2025-08-31T04:19:13Z

Jerethk:

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.

To use the feature, check that the '''Enhanced AI logics''' setting has been enabled, in Settings → Game Settings → Dark Forces Settings.

=== JSON locations ===
Custom logics are defined in JSON files. TFE will search for and load logics from all logic .JSON files found in these locations

* DARK\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.

In addition, if you are running a Mod from a ZIP, TFE will look for a <code>\Logics</code> subfolder inside the ZIP and load logics from any .JSON files found there.

Logics loaded from a Mod will take preference over any logics found in other locations that have the same name.

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 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 ===
A logic JSON should consist of a single array called "logics".

Each element of the "logics" array must consist of two items, in this order
* "logicName" - a string which is the name of the logic
* "data" - an object containing properties that are set for the logic

Example:
<pre>
{
"logics": [
{
"logicName": "LogicA",
"data": {
"alertSound": "alert1.voc",
"painSound": "pain1.voc",
"hitpoints": 25,
"projectile": "rifle_bolt"
}
},
{
"logicName": "LogicB",
"data": {
"alertSound": "alert2.voc",
"painSound": "pain2.voc",
"hitpoints": 39,
"speed": 20,
"projectile": "thermal_det",
"dropItem": "red_key"
}
}
]
}
</pre>

Logic JSONs are ''not'' case sensitive. The text inside the JSON can be all uppercase, all lowercase, or any mix of upper and lowercase; it will all be read the same.

For example, "alertsound", "ALERTSOUND", "AlertSound", "alertSound" will all be accepted.

Further tips about getting the JSON format right can be found on the [[TFE Mod Overrides#How_do_I_create_or_edit_a_MOD_CONF.txt_file_and_what_is_JSON?|TFE MOD Overrides]] article.

=== Data properties ===
Here is a list of the properties that you can set for each logic. They are all standard JSON key-value pairs.

You do not need to set every property. Unset properties will default to the values shown.

Properties can be listed in any order. Property names are not case sensitive, but need to be spelled correctly.

{| border=1 cellpadding=6px
|-
! Property !! Type !! Default value !! Description
|-
| hasGravity || boolean || <code>true</code> || If true, will be affected by gravity
|-
| isFlying || boolean || <code>false</code> || If true, will be a flying enemy (like probe droid)
|-
| fieldOfView || number (integer) || 210 || Field of view, in degrees. If set to 360, the enemy will be able to see you even if you are standing behind it.
|-
| awareRange || number (integer) || 20 || If you are within this distance from the enemy (in DFU), it will be alerted even if you are outside its field of view. (However, this can be affected by other things, such as the ambient light.)
|-
| 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
|-
| attack1Sound || string || ''no sound'' || VOC file to play for primary attack
|-
| attack2Sound || string || ''no sound'' || VOC file to play for secondary attack
|-
| hitPoints || number (integer) || 4 || Hitpoints. The enemy will die when it reaches 0.
|-
| dropItem || string or number || -1 (nothing) || What item is dropped 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.
|-
| 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.
|-
| hasRangedAttack || boolean || <code>true</code> || If true, the enemy will have a ranged attack. If the enemy has a melee attack, the ranged attack will be the secondary attack. If it does not have a melee attack, the ranged attack will be the primary attack.
|-
| litWithMeleeAttack || boolean || <code>false</code> || If true, the sprite will light up when it attacks with melee.
|-
| litWithRangedAttack || boolean || <code>true</code> || If true, the sprite will light up when it does its ranged attack.
|-
| projectile || string or number || <code>"rifle_bolt"</code> || What projectile the enemy will fire for its ranged attack. See reference table below for options.
|-
| wanderTime || number (integer) || 300 || How long (in seconds) the enemy will keep looking for the player, before it returns to its idle or "asleep" state. This time is reset when the enemy is re-alerted by the player.
|-
| rangedAttackDelay || number (decimal) || 2 || Time delay in seconds between range attacks (the game engine adds some variability to this)
|-
| meleeAttackDelay || number (decimal) || 0 || Time delay in seconds between melee attacks
|-
| meleeRange || number (integer) || 0 || Range (in DFU) of melee attack - how far the player can be from the enemy to be hit by it.
|-
| meleeDamage || number (integer) || 0 || Damage that each melee attack will inflict.
|-
| minAttackDist || number (integer) || 0 || Minimum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| maxAttackDist || number (integer) || 160 || Maximum distance from the player (DFU) where the enemy will attack with its ranged weapon.
|-
| fireSpread || number (integer) || 30 || Accuracy of fire. Lower numbers are more accurate.
|-
| speed || number (integer) || 4 || Speed of enemy's movement, appears to be in DFU per second. For flying enemies, this is their horizontal speed.
|-
| verticalSpeed || number (integer) || 10 || For flying enemies only, this is their vertical speed.
|-
| rotationSpeed || number (integer) || 720 || Speed at which the enemy can rotate. Degrees per second.
|}

=== Using custom logics ===
Logics that you have defined in JSON can be applied to a sprite in the .O file in the same way as other (hardcoded) enemy logics. For example, if you have the following logic

<pre>
"logicName": "Rodian",
"data": {
"alertSound": "rodian1.voc",
....
}
</pre>

Apply it to a sprite (WAX) like this, and then the sprite should behave with the custom logic.

<pre>
SEQ
LOGIC: Rodian
SEQEND
</pre>

You can also use JSON-defined logics with generators, for example

<pre>
SEQ
LOGIC: GENERATOR Rodian
DELAY: 10
INTERVAL: 5
NUM_TERMINATE: 6
MAX_ALIVE: 1
MAX_DIST: 800
MIN_DIST: 50
SEQEND
</pre>

'''Important''': If a level with a custom logic is run with vanilla Dark Forces or the Dark Forces Remaster, the sprites will be "lifeless". However, if the level has generators with a custom logic, this causes the original game to crash.

=== Overriding hardcoded logics ===
You ''can'' override hardcoded logics by creating a JSON logic with the same name as one of the hardcoded logics. For example, <code>storm1</code> and <code>commando</code>.

If you override a boss logic, like <code>kell</code> or one of the dark troopers, the enemy will behave like an ordinary enemy instead of a boss; they will lose their ability to trigger the BOSS elevator when they die.

=== Custom logics and WAX files ===
A custom logic's behaviours/actions will correspond to WAX animations as follows

{| border=1 cellpadding=6px
|-
| 0 || Walking / moving
|-
| 1 || Primary attack
|-
| 2 || Melee death
|-
| 3 || Shooting / explosion death
|-
| 4 || Dead
|-
| 5 || Idle / stationary
|-
| 6 || Primary attack conclusion (eg. recoil)
|-
| 7 || Secondary attack
|-
| 8 || Secondary attack conclusion
|-
| 9 || ''unused''
|-
| 10 || ''unused''
|-
| 11 || ''unused''
|-
| 12 || Pain
|}

This follows the same pattern as all the standard Dark Forces enemies.

Note that if a logic has a melee attack, this will always be the primary attack (animations 1 and 6). If a logic has ''only'' a ranged attack, then this will be the primary attack (animations 1 and 6). If a logic has both melee and ranged attacks, the melee will be primary (animations 1 and 6) and the ranged attack will be secondary (animations 7 and 8).

=== Reference ===
==== Projectile list ====
You can assign projectiles with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a projectile
|-
| 0 || <code>punch</code> || This is a special projectile used for the player's fists, and may not work with logics
|-
| 1 || <code>pistol_bolt</code>
|-
| 2 || <code>rifle_bolt</code>
|-
| 3 || <code>thermal_det</code>
|-
| 4 || <code>repeater</code>
|-
| 5 || <code>plasma</code> || Fusion cutter projectile
|-
| 6 || <code>mortar</code>
|-
| 7 || <code>land_mine</code>
|-
| 8 || <code>land_mine_prox</code> || Proximity land mine
|-
| 9 || <code>land_mine_placed</code>
|-
| 10 || <code>concussion</code>
|-
| 11 || <code>cannon</code>
|-
| 12 || <code>missile</code>
|-
| 13 || <code>turret_bolt</code>
|-
| 14 || <code>remote_bolt</code>
|-
| 15 || <code>exp_barrel</code> || An invisible projectile that is normally spawned when a barrel explodes
|-
| 16 || <code>homing_missile</code> || Mohc's homing missiles
|-
| 17 || <code>probe_proj</code> || Green interrogator droid projectile
|-
| 18 || <code>bobafett_ball</code> || Boba Fett's missiles
|}

==== Drop item list ====
You can assign drop items with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not drop anything when they die
|-
| 0 || <code>PLANS</code> || Death Star plans
|-
| 1 || <code>PHRIK</code>
|-
| 2 || <code>NAVA</code>
|-
| 3 || <code>DT_WEAPON</code>
|-
| 4 || <code>DATATAPE</code>
|-
| 5 || <code>RIFLE</code>
|-
| 6 || <code>AUTOGUN</code>
|-
| 7 || <code>MORTAR</code>
|-
| 8 || <code>FUSION</code>
|-
| 9 || <code>CONCUSSION</code>
|-
| 10 || <code>CANNON</code>
|-
| 11 || <code>ENERGY</code>
|-
| 12 || <code>POWER</code>
|-
| 13 || <code>PLASMA</code>
|-
| 14 || <code>DETONATOR</code>
|-
| 15 || <code>DETONATORS</code>
|-
| 16 || <code>SHELL</code> || Mortar shell
|-
| 17 || <code>SHELLS</code>
|-
| 18 || <code>MINE</code>
|-
| 19 || <code>MINES</code>
|-
| 20 || <code>MISSILE</code>
|-
| 21 || <code>MISSILES</code>
|-
| 22 || <code>SHIELD</code>
|-
| 23 || <code>RED_KEY</code>
|-
| 24 || <code>YELLOW_KEY</code>
|-
| 25 || <code>BLUE_KEY</code>
|-
| 26 || <code>GOGGLES</code>
|-
| 27 || <code>CLEATS</code>
|-
| 28 || <code>MASK</code> || Gas mask
|-
| 29 || <code>BATTERY</code>
|-
| 30 || <code>CODE1</code>
|-
| 31 || <code>CODE2</code>
|-
| 32 || <code>CODE3</code>
|-
| 33 || <code>CODE4</code>
|-
| 34 || <code>CODE5</code>
|-
| 35 || <code>CODE6</code>
|-
| 36 || <code>CODE7</code>
|-
| 37 || <code>CODE8</code>
|-
| 38 || <code>CODE9</code>
|-
| 39 || <code>INVINCIBLE</code> || Shield supercharge
|-
| 40 || <code>SUPERCHARGE</code> || Weapon supercharge
|-
| 41 || <code>REVIVE</code>
|-
| 42 || <code>LIFE</code>
|-
| 43 || <code>MEDKIT</code>
|-
| 44 || <code>PILE</code> || Kyle's pile of weapons
|}

==== Death effect list ====
You can assign death effects with either their number or their string. Make sure strings are spelled correctly, exactly as shown in this table (either lowercase or uppercase may be used).

Note that some effects inflict damage.

{| border=1 cellpadding=6px
|-
! Number !! String
|-
| -1 || || Enemy will not have a death effect
|-
| 0 || <code>SMALL_EXP</code> || small "puff" - blaster weapons
|-
| 1 || <code>THERMDET_EXP</code> || thermal detonator explosion
|-
| 2 || <code>PLASMA_EXP</code> || Green plasma "puff"
|-
| 3 || <code>MORTAR_EXP</code> || mortar explosion
|-
| 4 || <code>CONCUSSION</code> || concussion - first stage
|-
| 5 || <code>CONCUSSION2</code> || concussion - second stage
|-
| 6 || <code>MISSILE_EXP</code> || missile explosion
|-
| 7 || <code>MISSILE_WEAK</code> || weaker version of the missle explosion
|-
| 8 || <code>PUNCH</code> || punch
|-
| 9 || <code>CANNON_EXP</code> || Blue cannon "puff"
|-
| 10 || <code>REPEATER_EXP</code> || repeater "puff"
|-
| 11 || <code>LARGE_EXP</code> || Land mine explosion
|-
| 12 || <code>EXP_BARREL</code> || exploding barrel
|-
| 13 || <code>EXP_INVIS</code> || an explosion that makes no sound and has no visual effect
|-
| 14 || <code>SPLASH</code> || water splash
|-
| 15 || <code>EXP_35</code> || medium explosion, 35 damage (used for probe droid death)
|-
| 16 || <code>EXP_NO_DMG</code> || medium explosion, no damage (used for turret and welder deaths)
|-
| 17 || <code>EXP_25</code> || medium explosion, 25 damage (used for Boba Fett missile explosions)
|}

Script Object

2025-08-30T12:14:00Z

Jerethk: /* Object Methods */

Script Object

2025-08-30T11:51:48Z

Jerethk: /* Getting objects by name */

Script Object

2025-08-30T11:50:48Z

Jerethk: Methods

Script Object

2025-08-30T11:23:35Z

Jerethk: /* Object Properties */

'''Object Script''' enables manipulation of objects via ForceScript.

== Naming of objects ==
TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names.

Objects are named in the .O file as shown here:

<pre>
/* 006 SEWERBUG.WAX */
CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: SEWER1
NAME: sewer-creature2
SEQEND

/* 007 REMOTE.WAX */
CLASS: SPRITE DATA: 2 X: 280.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: REMOTE
NAME: cool-remote
SEQEND

/* 008 MOUSEBOT.3DO */
CLASS: 3D DATA: 2 X: 256.00 Y: 0.00 Z: 232.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1
SEQ
LOGIC: MOUSEBOT
NAME: mouse4
SEQEND
</pre>

== Getting objects by name ==
To get objects by their name, use the methods in the [[Level_Script_API#Methods|Level Script]] API.
* <code>getObject</code>
* <code>getObjectsByName</code>

== Object Properties ==

=== sector ===
* Get only
* Gets the object's current sector (<code>Sector</code>)
* Usage example: <code>Sector troopSector = my_trooper.sector</code>

=== position ===
* Get or set
* Gets or sets the object's position (float3)
* Usage example: move the object to coordinates x20, y80, z-350
<pre>
myObj.position = {20, 80, -350};
</pre>

=== yaw ===
* Get or set
* Gets or sets the object's yaw (float)
* Usage example: <code>myObj.yaw = 120.0;</code>

=== radius ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.radius = 1.5;</code>

=== worldWidth ===
* Get or set
* Gets or sets the object's radius / world width (float)
* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

=== height ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.height = 9.5;</code>

=== worldHeight ===
* Get or set
* Gets or sets the object's height / world height (float)
* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

Script Object

2025-08-30T09:04:59Z

Jerethk: Properties

Script Object

2025-08-30T08:52:37Z

Jerethk: Getting objects

Level Script API

2025-08-30T08:49:39Z

Jerethk: /* Methods */ object getters

Documentation for TFE Level Script API.

== Properties ==
=== minLayer ===
* Get only
* Gets the minimum map layer (signed integer)
* Usage example: <code>int i = level.minLayer;</code>

=== maxLayer ===
* Get only
* Gets the maximum map layer (signed integer)
* Usage example: <code>int i = level.maxLayer;</code>

=== sectorCount ===
* Get only
* Gets the total count of sectors (signed integer)
* Usage example: <code>int i = level.sectorCount</code>

=== secretCount ===
* Get only
* Gets the total count of secrets (signed integer)
* Usage example: <code>int i = level.secretCount</code>

=== textureCount ===
* Get only
* Gets the total count of textures (signed integer)
* Usage example: <code>int i = level.textureCount</code>

=== elevatorCount ===
* Get only
* Gets the total count of elevators (signed integer)
* Usage example: <code>int i = level.elevatorCount</code>

=== parallax ===
* Get only
* Gets the parallax (float2)
* Usage example:
<pre>
float2 pa = level.parallax;
float horzParallax = pa.x;
float vertParallax = pa.y;
</pre>

=== gravity ===
* Set only
* Sets the level's gravity (int)
* Usage example: <code>level.gravity = 80;</code>

=== projectileGravity ===
* Set only
* Sets the projectile gravity (int)
* Usage example: <code>level.projectileGravity = 60;</code>

== Special sector getters ==
=== bossSector ===
* Gets the boss sector (Sector)
* Usage example: <code>Sector bossSect = level.bossSector;</code>

=== mohcSector ===
* Gets the mohc sector (Sector)
* Usage example: <code>Sector mohcSect = level.mohcSector;</code>

=== completeSector ===
* Gets the complete sector (Sector)
* Usage example: <code>Sector completeSect = level.completeSector;</code>

== Methods ==
=== getSector(int) ===
* Return value: Sector
* Parameters: sector Id (int)
* Usage example: <code>Sector mySector = level.getSector(14);</code>

=== getSector(string) ===
* Return value: Sector
* Parameters: sector name (string)
* Usage example: <code>Sector mySector = level.getSector("door6");</code>

=== getElevator(int) ===
* Return value: Elevator
* Parameters: elevator Id (int)
* Usage example: <code>Elevator myElev = level.getElevator(9);</code>

=== findConnectedSectors(Sector, uint, array<Sector>) ===
* Return value: void
* Parameters:
** the starting sector (Sector)
** properties to match on (uint); see sector properties enum
** an array of sectors that will be populated with sectors which are connected (adjoined) to the starting sector
* Usage example: get sector 5, then get all the sectors adjoined to it
<pre>
Sector mySector = level.getSector(5);
array<Sector> sectorList;
level.findConnectedSectors(mySector, 0, sectorList);
system.print("My sector has {} adjoining sectors", sectorList.length);
</pre>

=== getObject(int) ===
* Return value: Object
* Parameter: object Id (int)

=== getObject(string) ===
* Gets an object by its name. If there are multiple objects with the same name, the first one found will be returned.
* Return value: Object
* Parameter: object name (string)
* Usage example: <code>Object myobj = level.getObject("commando_13");</code>

=== getObjectsByName(string, array<Object>) ===
* Gets all objects with a given name into an array.
* Return value: void
* Parameters:
** name of objects to get (string)
** an array of objects that will be populated by the function

* Usage example: get all objects that have the name "squad"
<pre>
array<Object> mySquad;
level.getObjectsByName("squad", mySquad);
system.print("There are {} objects in the list", mySquad.length);
</pre>

Script Object

2025-08-30T08:38:50Z

Jerethk: Created page with "'''Object Script''' enables manipulation of objects via ForceScript. == Naming of objects == TFE introduces the ability to name objects, so that they can be referenced by the scripting system. Names may be up to 32 characters and are ''case insensitive'' like sector names. Objects are named in the .O file as shown here: <pre> /* 006 SEWERBUG.WAX */ CLASS: SPRITE DATA: 3 X: 232.00 Y: 0.00 Z: 264.00 PCH: 0.00 YAW: 0.00 ROL: 0.00 DIFF: 1 SEQ LOGIC: SEWER1..."

Player Script API

2025-04-18T03:04:05Z

Jerethk: /* Properties */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerAction</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

=== disabledActions ===
* Get the player actions that have currently been disabled
* Usage example: check if firing has been disabled
<pre>
if (player.disabledActions & ACTION_FIRE)
{
// firing has been disabled
}
</pre>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== disableActions(PlayerActions) ===
* Disable the player's actions
* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: disable player's movement and weapon firing
<pre>
player.disableActions(ACTION_MOVE | ACTION_FIRE);
</pre>

Disable all actions (movement, rotation and firing)
<pre>
player.disableActions(ACTION_ALL);
</pre>

=== enableActions(PlayerActions) ===
* Enable the player's actions if they have been disabled
* Parameter: actions to enable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: enable player's movement and rotation
<pre>
player.enableActions(ACTION_MOVE | ACTION_ROTATE);
</pre>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Player Script API

2025-04-18T02:59:24Z

Jerethk: /* Methods */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerAction</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== disableActions(PlayerActions) ===
* Disable the player's actions
* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: disable player's movement and weapon firing
<pre>
player.disableActions(ACTION_MOVE | ACTION_FIRE);
</pre>

Disable all actions (movement, rotation and firing)
<pre>
player.disableActions(ACTION_ALL);
</pre>

=== enableActions(PlayerActions) ===
* Enable the player's actions if they have been disabled
* Parameter: actions to enable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: enable player's movement and rotation
<pre>
player.enableActions(ACTION_MOVE | ACTION_ROTATE);
</pre>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Player Script API

2025-04-18T02:53:13Z

Jerethk: /* Methods */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerAction</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== disableActions(PlayerAction) ===
* Disable the player's actions
* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
* Usage example: disable player's movement and weapon firing
<pre>
player.disableActions(ACTION_MOVE | ACTION_FIRE);
</pre>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Player Script API

2025-04-18T02:47:01Z

Jerethk: /* PlayerActions enum */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerAction</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Player Script API

2025-04-18T02:46:35Z

Jerethk: /* Enums */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

==== <code>PlayerActions</code> enum ====
{|
|-
| ACTION_MOVE
|-
| ACTION_ROTATE
|-
| ACTION_FIRE
|-
| ACTION_ALL
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Level Script API

2025-04-18T02:40:42Z

Jerethk: /* Methods */

Player Script API

2025-04-01T11:03:25Z

Jerethk: /* Methods */

Documentation for TFE Player Script API.

== Enums ==

==== <code>ITEM</code> enum ====
{|
|-
| PLANS
|-
| PHRIK
|-
| NAVA
|-
| DT_WEAPON
|-
| DATATAPE
|-
| ITEM10
|}

==== <code>WEAPON</code> enum ====
{|
|-
| PISTOL
|-
| RIFLE
|-
| REPEATER
|-
| FUSION
|-
| MORTAR
|-
| CONCUSSION
|-
| CANNON
|}

==== <code>AMMO</code> enum ====
{|
|-
| AMMO_ENERGY
|-
| AMMO_POWER
|-
| AMMO_DETONATOR
|-
| AMMO_SHELL
|-
| AMMO_PLASMA
|-
| AMMO_MINE
|-
| AMMO_MISSILE
|}

== Properties ==

=== position ===
* Get or set
* Gets or sets the player's current position (float3)
* You will not be allowed to move the player outside of a sector
* Usage example: get the current player position and change it to 10 units higher altitude
<pre>
float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};
</pre>

=== yaw ===
* Get or set
* Gets or sets the player's yaw, in degrees (float)
* Usage example: make the player face south
* <code>player.yaw = 180;</code>

=== velocity ===
* Get or set
* Gets or sets the player's velocity (float3)
* Usage example: set the player's velocity to 100 north + 100 west
<pre>player.velocity = {-100.0, 0, 100.0};</pre>

* Usage example: set the player's velocity to 50 upwards and 30 south
<pre>player.velocity = {0, 50.0, -30.0};</pre>

=== health ===
* Get or set
* Gets or sets the player's health (int)
* Usage example: <code>player.health = 80;</code>

=== shields ===
* Get or set
* Gets or sets the player's shields (int)
* Usage example: <code>player.shields = 200;</code>

=== battery ===
* Get or set
* Gets or sets the player's battery, as a percentage (int)
* Usage example: <code>player.battery = 60; // 60 percent battery will be 3 lights on the HUD</code>

== Methods ==

=== kill() ===
* Instantly kill the player
* Usage example: <code>player.kill();</code>

=== addToHealth(int) ===
* Add an amount to the player's health
* Parameter: amount (int)
* Usage example: <code>player.addToHealth(-30); // subtract 30 from the player's health</code>

=== addToShields(int) ===
* Add an amount to the player's shields
* Parameter: amount (int)
* Usage example: <code>player.addToShields(10);</code>

=== getAmmo(AMMO) ===
* returns the current amount of ammo (int)
* Parameter: ammo type (AMMO enum)
* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

=== setAmmo(AMMO, int) ===
* sets the ammo to a value
* Parameters: ammo type (AMMO enum), value (int)
* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

=== hasRedKey() ===
* returns <code>true</code> if the player has the red key
* Usage example:
<pre>if (player.hasRedKey())
{
....
} </pre>

=== hasBlueKey() ===
* returns <code>true</code> if the player has the blue key

=== hasYellowKey() ===
* returns <code>true</code> if the player has the yellow key

=== hasGoggles() ===
* returns <code>true</code> if the player has the IR Goggles

=== hasCleats() ===
* returns <code>true</code> if the player has the ice cleats

=== hasMask() ===
* returns <code>true</code> if the player has the gasmask

=== giveRedKey() ===
* adds the red key to the player's inventory
* usage example: <code>player.giveRedKey();</code>

=== giveBlueKey() ===
* adds the blue key to the player's inventory

=== giveYellowKey() ===
* adds the yellow key to the player's inventory

=== giveGoggles() ===
* adds the IR Goggles to the player's inventory

=== giveCleats() ===
* adds the ice cleats to the player's inventory

=== giveMask() ===
* adds the gas mask to the player's inventory

=== removeRedKey() ===
* removes the red key from the player's inventory
* usage example: <code>player.removeRedKey();</code>

=== removeBlueKey() ===
* removes the blue key from the player's inventory

=== removeYellowKey() ===
* removes the yellow key from the player's inventory

=== removeGoggles() ===
* removes the IR Goggles key from the player's inventory

=== removeCleats() ===
* removes the ice cleats from the player's inventory

=== removeMask() ===
* removes the gas mask from the player's inventory

=== giveCodeKey(int) ===
* adds a code key to the inventory
* Parameter: number of code key (1 to 9)
* Usage example: <code>player.giveCodeKey(4);</code>

=== giveItem(ITEM) ===
* adds an item to the player's inventory
* Parameter: item type (see <code>ITEM</code> enum)
* Usage example: <code>player.giveItem(PHRIK)</code>

=== hasWeapon(WEAPON) ===
* returns <code>true</code> if the player has the weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example:
<pre>
if (player.hasWeapon(FUSION))
{
....
}
</pre>

=== giveWeapon(WEAPON) ===
* gives the player a weapon
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

=== removeWeapon(WEAPON) ===
* removes a weapon from the player's inventory
* Parameter: weapon type (see <code>WEAPON</code> enum)
* Usage example: <code>player.removeWeapon(RIFLE);</code>

Player Script API

2025-04-01T10:54:31Z

Jerethk: /* Methods */

Player Script API

2025-04-01T10:42:58Z

Jerethk: /* Methods */

Level Script API

2025-03-28T17:58:26Z

Jerethk:

Documentation for TFE Level Script API.

== Properties ==
=== minLayer ===
* Get only
* Gets the minimum map layer (signed integer)
* Usage example: <code>int i = level.minLayer;</code>

=== maxLayer ===
* Get only
* Gets the maximum map layer (signed integer)
* Usage example: <code>int i = level.maxLayer;</code>

=== sectorCount ===
* Get only
* Gets the total count of sectors (signed integer)
* Usage example: <code>int i = level.sectorCount</code>

=== secretCount ===
* Get only
* Gets the total count of secrets (signed integer)
* Usage example: <code>int i = level.secretCount</code>

=== textureCount ===
* Get only
* Gets the total count of textures (signed integer)
* Usage example: <code>int i = level.textureCount</code>

=== elevatorCount ===
* Get only
* Gets the total count of elevators (signed integer)
* Usage example: <code>int i = level.elevatorCount</code>

=== parallax ===
* Get only
* Gets the parallax (float2)
* Usage example:
<pre>
float2 pa = level.parallax;
float horzParallax = pa.x;
float vertParallax = pa.y;
</pre>

=== gravity ===
* Set only
* Sets the level's gravity (int)
* Usage example: <code>level.gravity = 80;</code>

=== projectileGravity ===
* Set only
* Sets the projectile gravity (int)
* Usage example: <code>level.projectileGravity = 60;</code>

== Special sector getters ==
=== bossSector ===
* Gets the boss sector (Sector)
* Usage example: <code>Sector bossSect = level.bossSector;</code>

=== mohcSector ===
* Gets the mohc sector (Sector)
* Usage example: <code>Sector mohcSect = level.mohcSector;</code>

=== completeSector ===
* Gets the complete sector (Sector)
* Usage example: <code>Sector completeSect = level.completeSector;</code>

== Methods ==
=== getSector(int) ===
* Return value: Sector
* Parameters: sector Id (int)
* Usage example: <code>Sector mySector = level.getSector(14);</code>

=== getElevator(int) ===
* Return value: Elevator
* Parameters: elevator Id (int)
* Usage example: <code>Elevator myElev = level.getElevator(9);</code>

=== findConnectedSectors(Sector, uint, array<Sector>) ===
* Return value: void
* Parameters:
** the starting sector (Sector)
** properties to match on (uint); see sector properties enum
** an array of sectors that will be populated with sectors which are connected (adjoined) to the starting sector
* Usage example: get sector 5, then get all the sectors adjoined to it
<pre>
Sector mySector = level.getSector(5);
array<Sector> sectorList;
level.findConnectedSectors(mySector, 0, sectorList);
system.print("My sector has {} adjoining sectors", sectorList.length);
</pre>

Player Script API

2025-03-28T16:27:53Z

Jerethk:

Player Script API

2025-03-28T16:18:39Z

Jerethk:

Player Script API

2025-03-28T15:56:39Z

Jerethk: enums

Player Script API

2025-03-28T15:49:23Z

Jerethk: Created page with "Documentation for TFE Player Script API."

Documentation for TFE Player Script API.

TFE Mod Overrides

2025-03-23T08:26:20Z

Jerethk: /* THE Override Configuration Details */

On this page we will discuss how to override The Force Engine (TFE) mod configurations. We will discuss using a custom mod configuration file that looks like this. At the moment, there are two types of overrides. One type is processed only by TFE and another is processed by both Dark Forces Remaster and TFE. We will first talk about the TFE-only overrides.
[[File:ModConfImageTrue.png|center|thumb]]

== What is a Mod Configuration File? ==
You can change many different aspects of your mod by placing a configuration file called '''MOD_CONF.txt''' inside your mod's GOB archive (using a tool like [https://df-21.net/downloads/utilities.php Conman] ). When present, this file will make TFE act differently than it would in a regular game. You could change the amount of lives you have on start, and what weapons are available. You can even start the mission wearing a Gas Mask! '''''Note:''' The Dark Forces Remaster only loads MOD_CONF from the GOB!''

[[File:MOD CONF Gob.png|thumb|541x541px|The MOD_CONF.txt should look like this in your GOB...|center]]Now that you know where to place the configuration file, lets look inside it!
=== How do I create or edit a MOD_CONF.txt file and what is JSON? ===
Simply open your favorite text editor (like Notepad) and create a new file. Then you will be able to edit the text as necessary. The file itself is in the format of a JSON like the level metadata.txt. You can read about the format here --> [https://www.w3schools.com/js/js_json_intro.asp JSON Tutorial] . Basically, you surround each section with brackets { and } putting configuration data inside each section. Any word '''must''' to be surrounded with '''quotation''' '''marks'''. Each configuration is in the format of '''KEY :''' VALUE

And example could be "hello" : "world" or "dark" : "forces". In this case, the name of the key is '''hello''' or '''dark''' and the value is '''world''' or '''forces.''' Then you surround everything with brackets.
'''{"hello" : "world"}'''
That's what a valid configuration looks like above. You can also place one configuration inside another.
'''<nowiki>{"hello" : {"dark": "forces"}}</nowiki>'''
So in the case above the key '''hello''' is equal to another key-value pair called {"dark" :"forces"}. You can put as many as you want inside each other.

If you have multiple values just add commas between them.
{"name" : "Kyle", "lastname" : "Katarn", "Age" : 25, ...... etc... }
'''IMPORTANT!!! It is very easy to make a typo in your JSON file. Go to this website, paste your MOD_CONF.txt''' contents and verify that there are no errors --> https://jsonlint.com/

Remember after you create your MOD_CONF.txt to add it your GOB archive.

==== What is the structure of a MOD_CONF.txt file? ====
Below is a an example of a level configuration.

At the top the first key is '''TFE_VERSION''' . This is a validation checks that tells the The Force Engine two things. The first is what format the MOD_CONF file is in. We may add new categories and structures to the JSON as times goes along. Additionally, the version may tell TFE what features MOD_CONF expects to be supported. As we add more features the MOD_CONF the version will increase. At the moment, the version is '''1''' and supports all features. If this value is missing the validation is skipped and, if there are any issues, the loading of the override is skipped.

The second key is '''TFE_OVERRIDES'''. This tells the game that everything inside is used as configuration for TFE.
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"levelOverrides": {
"SECBASE.LEV": {
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
},
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
}
}
}

==== TFE Setting Overrides ====
Inside the TFE overrides section you can add your own custom setting overrides. For example, if you want to disable fight music you can do so by either going into the Game Settings and check the values you want enabled or disabled. Or you can do it by updating the MOD_CONF.txt file by adding your own overrides. For example, if you want to disable fight music in your mod with overrides, add the key '''"disableFightMusic"''' and set the value to '''true''' or '''false'''.
"disableFightMusic" : true
And if you want to always run you can add a new TFE Override '''autorun''' and set it to true.
"autorun" : true
Below is an example of how the setting options look like in the user interface. You can get to these by going into the Settings section of The Force Engine and clicking on "Game Settings".
[[File:Override Settings.png|center|thumb|677x677px]]
You can replicate the above using the mod_conf TFE overrides. A full example of the above picture is shown below.
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"disableFightMusic" : true,
"enableAutoaim" : true,
"showSecretFoundMsg" : true,
"bobaFettFacePlayer" : true,
"ignoreInfLimit" : true,
"solidWallFlagFix" : true,
"enableUnusedItem" : true,
}
}
Here is the full description of the override settings.
disableFightMusic - Turns off the fight music in your mod
enableAutoaim - Turns the autoaiming on or off.
showSecretFoundMsg - Allows you to toggle the secret found message added to TFE.
autorun - Toggles the autorun option.
crouchToggle - Changes how crouch behaves. You can press it once to toggle crouching instead of holding a button.
bobaFettFacePlayer - A fix to make Boba Fett face the player.
smoothVUEs - Makes VUE transitions smoother by normalizing the fractional frame indexes.
ignoreInfLimit - Removes the limit of INF scripts.
stepSecondAlt - Allows you to automatically step on to Second Altitude sectors.
solidWallFlagFix - Solid wall flag is enforced for collision with moving walls
enableUnusedItem - Enables the unused item in the inventory (delt 10).
Simply apply them as you see fit for your mod. This section will expand as more overrides become available.

And now we will talk about a special TFE override setting called '''levelOverrrides'''.

==== Level Overrides ====
Inside the TFE overrides section there is also an '''levelOverrides''' section. This tells the game that there will be a configuration for each level name that you define.

Inside the '''levelOverrides''' section is a comma-separated listing of levels you want to override. For example if you want to change the behavior of SECBASE you would add SECBASE.LEV configuration and if you want to configure TALAY then you would write down TALAY.LEV. You can add as many as you want depending on how many maps you have in your GOB.

===== Structure of a Level Override Section =====
Lets look at the detail of level override section. You will see that it is a listing of key-value pairs. Some of them are set to '''true''' or '''false''' and some have numerical values.

====== SECBASE.LEV ======
Lets look at the section for '''SECBASE.LEV'''
"SECBASE.LEV":
{
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
}
What each key does is change the behavior of the level in the game. Lets look at the part that says
"pistol": false,
In this case, the key is '''pistol''' and the value is '''false.''' This means that it will '''remove''' the pistol from the mission's inventory. Lets continue...
"rifle": true,
In this case, the key is '''rifle''' and the value is '''true.''' This means that the game will '''add''' the rifle to your inventory.
"power": 300,
In this case, the key is '''power''' and the value is '''300.''' This means that the game will '''set the repeater ammo power to 300 units.''' Notice that there are no quotes around 300 - that's because we don't need to do that when dealing with numbers.
"detonator": 5,
In this case, the key is '''detonator''' and the value is '''5.''' This means that the game will '''set the thermal detonator to 5.'''
"shields": 150
In this case, the key is '''shields''' and the value is '''150.''' This means that the game will '''set the shields to 150.''' Note that there is no comma after 150 .

Remember, all of these changes only apply to the SECBASE.LEV mission!

====== TALAY.LEV ======
Now lets look at the next section for TALAY.LEV.
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
Here, we have two key - value pairs.
"bryarOnly" : true,
In this case, the key is '''bryarOnly''' and the value is '''true.''' This means that the game will '''remove''' your entire inventory and give you only a bryar pistol!
"lives": 1
In this case, the key is '''lives''' and the value is '''1''' This means that the game will '''give you only 1 life!'''

=== THE Override Configuration Details ===
Now that you know how everything works lets go over each key and what it does!

===== Weapons and Inventory =====
When you set the value to '''true''' item will be added. When set to '''false''' the item will be removed from the player's inventory. So if your key is "'''pistol'''" then the two values you can set are either '''true''' or '''f'''alse.
pistol - Add or Remove the Bryar Pistol from the inventory
rifle - Add or Remove the E-11 Imperial Rifle from the inventory
autogun - Add or Remove the Repeater Gun from the inventory
mortar - Add or Remove the Packard Mortar from the inventory
fusion - Add or Remove the Fusion Cutter from the inventory
concussion - Add or Remove the Concussion Rifle from the inventory
cannon - Add or Remove the Dark Trooper Cannon from the inventory
mask - Add or Remove the Gas Mask from the inventory
goggles - Add or Remove the Night Vision Goggles from the inventory
cleats - Add or Remove the Ice Cleats from the inventory

===== Ammunition and Health =====
These typically set your a numeric value for your ammunition and health. Just give the value nice whole numbers between 0 and the Max.
energy - Set the Energy (For E-11) ammunition to a specific value. Max is '''999'''
power - Set the Power (For the Repeater) ammunition to a specific value. Max is '''999'''
plasma - Set the Power (For the DT Cannon) ammunition to a specific value. Max is '''999'''
detonator - Set the Thermal Detonator count. Max is '''999'''.
shell - Set the Mortar Shells (for the Packard Mortar Cannon) to a specific value. Max is '''999'''.
mine - Set the Imperial Mine count. Max is '''999.'''
missile - Set the DT Weapon missiles to a specific value. Max is '''99.'''
shields - Set your shields to a specific value. Max is '''999.'''
health - Set your health to a specific value. Max is '''999.'''
lives - Set your lives to a specific value. Max is '''9.'''
battery - Set your battery to a specific value. This is a percentage between '''0''' and '''100'''.

===== Custom Numerical Overrides =====
defaultWeapon - Set your starting equipped weapon. '''1''' is fists, '''2''' is Bryar ... '''0''' is the DT Cannon. Values between '''0''' and '''9'''.
fogLevel - Set the fog attenuation (Gromas Mines defaults to 30). Values between 0 and 100.
floorDamageLow - Set the low floor damage amount (player hitpoints per second, normal is 5)
floorDamageHigh - Set the high floor damage amount (player hitpoints per second, normal is 10)
gasDamage - Set the gas damage amount (player hitpoints per second, normal is 5)
wallDamage - Set the wall damage amount (player hitpoints per second, normal is 20)
gravity - Set the level's gravity for player and enemies (normal is 150)
projectileGravity - Set the level's gravity for projectiles (normal is 120)
shieldSuperchargeDuration - Set the duration of the shield supercharge (seconds)
weaponSuperchargeDuration - Set the duration of the weapon supercharge (seconds)

headlampBatteryConsumption - Set the headlamp battery consumption rate (float value, % per second, normal is 0.208)
gogglesBatteryConsumption - Set the IR goggles battery consumption rate (float value, % per second, normal is 0.833)
maskBatteryConsumption - Set the gasmask battery consumption rate (float value, % per second, normal is 0.833)

===== Custom Overrides =====
We have some custom overrides for your mod.
enableMask - Start the mission with your Gas Mask on
enableCleats - Start the mission with your Ice Cleats on.
enableNightVision - Start the mission with your Night Vision enabled.
enableHeadlamp - Start the mission with your Head Lamp on.
bryarOnly - Start your mission with no inventory except a Bryar pistol and 100 ammo just like the first misison.

=== Dark Forces Remaster HD Overrides ===
'''Note:''' This is strictly optional and really should only be used to fix incorrect textures shown in the remaster!

There is another optional type of override that can be added to MOD_CONF.txt file. These overrides change the quality of assets that are loaded into the game. The game will either load the High Definition (HD) or original low quality assets. This is required because, by default, the assets in the Dark Forces Remaster skip texture paletting and only show the HD version of the texture even if it doesn't fit the modded level. Most of the time you will never have to deal with this but some custom maps that use the GROMAS, JABSHIP, SEWERS or TALAY palettes will look strange in the remaster.

[[File:MOD CONF HD.png|center|thumb]]
For now, lets go over the structure of the HD overrides. Just like before, you add the JSON overrides to MOD_CONF.txt like before. The idea is that you can specify whether to show HD or non HD versions of the PDA menu and the Mission Briefings. Additionally, you can specify per level, which textures you can override to show the non-HD versions instead of the HD versions. The asset types you can override are '''BMs''' (Textures), '''FMEs''' (Frames - Ex: Ammo Pick up) , WAX (Sprites like enemy stormtroopers) .

For each asset type you would list the asset that should show the '''original''' version instead of the HD version. So if you want to show the original low-quality version of '''GPDIRTRD.BM''' you would add it to the list of BMs.
{
"HD_PDA": false,
"HD_BRIEF": false,
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]
}
}

Here is the low quality version of the '''GPDIRTRD.BM'''. If this override is added to MOD_CONF.txt then Dark Forces Remaster and TFE will show the original low quality version.
[[File:GPDIRTD LOW.png|center|thumb]]
If you remove the texture from the list it will show the default high-res version like the one below.
[[File:GPDIRTRD HIGH RES.png|center|thumb]]
The same concept works for FME and WAX assets. Just add them to the list of assets.

==== HD override details ====
Here are the '''true''' or '''false''' overrides for high resolution PDA or briefing. Both the Dark Forces Remaster and TFE will process these settings.
HD_PDA - Display the original or the high resolution version of the PDA. This is useful for custom imperial codes ('''true''' or '''false''')
HD_BRIEF - Display the original or the high resolution version of the Mission Briefing ('''true''' or '''false''').
Then we have a list of levels that should be overrides. Just like before you would write the name of the mission like SECBASE.LEV or TALAY.LEV and then list the types of assets that should show the low quality versions. The asset lists can be BMs FMEs or WAXs and are comma separated surrounded by brackets.
<level_name>.LEV - Name of Level to override HD assets. Can be SECBASE.LEV, TALAY.LEV etc...
<asset_type> - Must be either BM, WAX or FME.
An example is below for mission '''SECBASE.LEV'''
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]

When you add this override, it will show the low-quality version of textures '''GPDIRTRD.BM, SPSEWGE3.BM''' and '''GPMINE1X.BM''' from the BM list'''.''' It will also display the low-quality version of '''GFPIPEIS1.FME''' frame in the FME list. Finally, the Kell Dragon will be of low quality due to '''KELL.WAX''' being added to the WAX list.

Putting it altogether your MOD_CONF may look like this. Don't forget to ALWAYS check that you do not have any typos and validate with this website -->https://jsonlint.com/
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"levelOverrides": {
"SECBASE.LEV": {
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
},
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
}
},
"HD_PDA": false,
"HD_BRIEF": false,
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]
}
}
Remember, if you are stuck or confused somewhere ask in the DF-21 [https://discord.gg/6T9NvMh2MC Discord] .

TFE Mod Overrides

2025-03-23T07:27:21Z

Jerethk: /* Custom Numerical Overrides */ add new ones

On this page we will discuss how to override The Force Engine (TFE) mod configurations. We will discuss using a custom mod configuration file that looks like this. At the moment, there are two types of overrides. One type is processed only by TFE and another is processed by both Dark Forces Remaster and TFE. We will first talk about the TFE-only overrides.
[[File:ModConfImageTrue.png|center|thumb]]

== What is a Mod Configuration File? ==
You can change many different aspects of your mod by placing a configuration file called '''MOD_CONF.txt''' inside your mod's GOB archive (using a tool like [https://df-21.net/downloads/utilities.php Conman] ). When present, this file will make TFE act differently than it would in a regular game. You could change the amount of lives you have on start, and what weapons are available. You can even start the mission wearing a Gas Mask! '''''Note:''' The Dark Forces Remaster only loads MOD_CONF from the GOB!''

[[File:MOD CONF Gob.png|thumb|541x541px|The MOD_CONF.txt should look like this in your GOB...|center]]Now that you know where to place the configuration file, lets look inside it!
=== How do I create or edit a MOD_CONF.txt file and what is JSON? ===
Simply open your favorite text editor (like Notepad) and create a new file. Then you will be able to edit the text as necessary. The file itself is in the format of a JSON like the level metadata.txt. You can read about the format here --> [https://www.w3schools.com/js/js_json_intro.asp JSON Tutorial] . Basically, you surround each section with brackets { and } putting configuration data inside each section. Any word '''must''' to be surrounded with '''quotation''' '''marks'''. Each configuration is in the format of '''KEY :''' VALUE

And example could be "hello" : "world" or "dark" : "forces". In this case, the name of the key is '''hello''' or '''dark''' and the value is '''world''' or '''forces.''' Then you surround everything with brackets.
'''{"hello" : "world"}'''
That's what a valid configuration looks like above. You can also place one configuration inside another.
'''<nowiki>{"hello" : {"dark": "forces"}}</nowiki>'''
So in the case above the key '''hello''' is equal to another key-value pair called {"dark" :"forces"}. You can put as many as you want inside each other.

If you have multiple values just add commas between them.
{"name" : "Kyle", "lastname" : "Katarn", "Age" : 25, ...... etc... }
'''IMPORTANT!!! It is very easy to make a typo in your JSON file. Go to this website, paste your MOD_CONF.txt''' contents and verify that there are no errors --> https://jsonlint.com/

Remember after you create your MOD_CONF.txt to add it your GOB archive.

==== What is the structure of a MOD_CONF.txt file? ====
Below is a an example of a level configuration.

At the top the first key is '''TFE_VERSION''' . This is a validation checks that tells the The Force Engine two things. The first is what format the MOD_CONF file is in. We may add new categories and structures to the JSON as times goes along. Additionally, the version may tell TFE what features MOD_CONF expects to be supported. As we add more features the MOD_CONF the version will increase. At the moment, the version is '''1''' and supports all features. If this value is missing the validation is skipped and, if there are any issues, the loading of the override is skipped.

The second key is '''TFE_OVERRIDES'''. This tells the game that everything inside is used as configuration for TFE.
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"levelOverrides": {
"SECBASE.LEV": {
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
},
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
}
}
}

==== TFE Setting Overrides ====
Inside the TFE overrides section you can add your own custom setting overrides. For example, if you want to disable fight music you can do so by either going into the Game Settings and check the values you want enabled or disabled. Or you can do it by updating the MOD_CONF.txt file by adding your own overrides. For example, if you want to disable fight music in your mod with overrides, add the key '''"disableFightMusic"''' and set the value to '''true''' or '''false'''.
"disableFightMusic" : true
And if you want to always run you can add a new TFE Override '''autorun''' and set it to true.
"autorun" : true
Below is an example of how the setting options look like in the user interface. You can get to these by going into the Settings section of The Force Engine and clicking on "Game Settings".
[[File:Override Settings.png|center|thumb|677x677px]]
You can replicate the above using the mod_conf TFE overrides. A full example of the above picture is shown below.
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"disableFightMusic" : true,
"enableAutoaim" : true,
"showSecretFoundMsg" : true,
"bobaFettFacePlayer" : true,
"ignoreInfLimit" : true,
"solidWallFlagFix" : true,
"enableUnusedItem" : true,
}
}
Here is the full description of the override settings.
disableFightMusic - Turns off the fight music in your mod
enableAutoaim - Turns the autoaiming on or off.
showSecretFoundMsg - Allows you to toggle the secret found message added to TFE.
autorun - Toggles the autorun option.
crouchToggle - Changes how crouch behaves. You can press it once to toggle crouching instead of holding a button.
bobaFettFacePlayer - A fix to make Boba Fett face the player.
smoothVUEs - Makes VUE transitions smoother by normalizing the fractional frame indexes.
ignoreInfLimit - Removes the limit of INF scripts.
stepSecondAlt - Allows you to automatically step on to Second Altitude sectors.
solidWallFlagFix - Solid wall flag is enforced for collision with moving walls
enableUnusedItem - Enables the unused item in the inventory (delt 10).
Simply apply them as you see fit for your mod. This section will expand as more overrides become available.

And now we will talk about a special TFE override setting called '''levelOverrrides'''.

==== Level Overrides ====
Inside the TFE overrides section there is also an '''levelOverrides''' section. This tells the game that there will be a configuration for each level name that you define.

Inside the '''levelOverrides''' section is a comma-separated listing of levels you want to override. For example if you want to change the behavior of SECBASE you would add SECBASE.LEV configuration and if you want to configure TALAY then you would write down TALAY.LEV. You can add as many as you want depending on how many maps you have in your GOB.

===== Structure of a Level Override Section =====
Lets look at the detail of level override section. You will see that it is a listing of key-value pairs. Some of them are set to '''true''' or '''false''' and some have numerical values.

====== SECBASE.LEV ======
Lets look at the section for '''SECBASE.LEV'''
"SECBASE.LEV":
{
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
}
What each key does is change the behavior of the level in the game. Lets look at the part that says
"pistol": false,
In this case, the key is '''pistol''' and the value is '''false.''' This means that it will '''remove''' the pistol from the mission's inventory. Lets continue...
"rifle": true,
In this case, the key is '''rifle''' and the value is '''true.''' This means that the game will '''add''' the rifle to your inventory.
"power": 300,
In this case, the key is '''power''' and the value is '''300.''' This means that the game will '''set the repeater ammo power to 300 units.''' Notice that there are no quotes around 300 - that's because we don't need to do that when dealing with numbers.
"detonator": 5,
In this case, the key is '''detonator''' and the value is '''5.''' This means that the game will '''set the thermal detonator to 5.'''
"shields": 150
In this case, the key is '''shields''' and the value is '''150.''' This means that the game will '''set the shields to 150.''' Note that there is no comma after 150 .

Remember, all of these changes only apply to the SECBASE.LEV mission!

====== TALAY.LEV ======
Now lets look at the next section for TALAY.LEV.
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
Here, we have two key - value pairs.
"bryarOnly" : true,
In this case, the key is '''bryarOnly''' and the value is '''true.''' This means that the game will '''remove''' your entire inventory and give you only a bryar pistol!
"lives": 1
In this case, the key is '''lives''' and the value is '''1''' This means that the game will '''give you only 1 life!'''

=== THE Override Configuration Details ===
Now that you know how everything works lets go over each key and what it does!

===== Weapons and Inventory =====
When you set the value to '''true''' item will be added. When set to '''false''' the item will be removed from the player's inventory. So if your key is "'''pistol'''" then the two values you can set are either '''true''' or '''f'''alse.
pistol - Add or Remove the Bryar Pistol from the inventory
rifle - Add or Remove the E-11 Imperial Rifle from the inventory
autogun - Add or Remove the Repeater Gun from the inventory
mortar - Add or Remove the Packard Mortar from the inventory
fusion - Add or Remove the Fusion Cutter from the inventory
concussion - Add or Remove the Concussion Rifle from the inventory
cannon - Add or Remove the Dark Trooper Cannon from the inventory
mask - Add or Remove the Gas Mask from the inventory
goggles - Add or Remove the Night Vision Goggles from the inventory
cleats - Add or Remove the Ice Cleats from the inventory

===== Ammunition and Health =====
These typically set your a numeric value for your ammunition and health. Just give the value nice whole numbers between 0 and the Max.
energy - Set the Energy (For E-11) ammunition to a specific value. Max is '''999'''
power - Set the Power (For the Repeater) ammunition to a specific value. Max is '''999'''
plasma - Set the Power (For the DT Cannon) ammunition to a specific value. Max is '''999'''
detonator - Set the Thermal Detonator count. Max is '''999'''.
shell - Set the Mortar Shells (for the Packard Mortar Cannon) to a specific value. Max is '''999'''.
mine - Set the Imperial Mine count. Max is '''999.'''
missile - Set the DT Weapon missiles to a specific value. Max is '''99.'''
shields - Set your shields to a specific value. Max is '''999.'''
health - Set your health to a specific value. Max is '''999.'''
lives - Set your lives to a specific value. Max is '''9.'''
battery - Set your battery to a specific value. This is a percentage between '''0''' and '''100'''.

===== Custom Numerical Overrides =====
defaultWeapon - Set your starting equipped weapon. '''1''' is fists, '''2''' is Bryar ... '''0''' is the DT Cannon. Values between '''0''' and '''9'''.
fogLevel - Set the fog attenuation (Gromas Mines defaults to 30). Values between 0 and 100.
floorDamageLow - Set the low floor damage amount (player hitpoints per second, normal is 5)
floorDamageHigh - Set the high floor damage amount (player hitpoints per second, normal is 10)
gasDamage - Set the gas damage amount (player hitpoints per second, normal is 5)
wallDamage - Set the wall damage amount (player hitpoints per second, normal is 20)
gravity - Set the level's gravity for player and enemies (normal is 150)
projectileGravity - Set the level's gravity for projectiles (normal is 120)

===== Custom Overrides =====
We have some custom overrides for your mod.
enableMask - Start the mission with your Gas Mask on
enableCleats - Start the mission with your Ice Cleats on.
enableNightVision - Start the mission with your Night Vision enabled.
enableHeadlamp - Start the mission with your Head Lamp on.
bryarOnly - Start your mission with no inventory except a Bryar pistol and 100 ammo just like the first misison.

=== Dark Forces Remaster HD Overrides ===
'''Note:''' This is strictly optional and really should only be used to fix incorrect textures shown in the remaster!

There is another optional type of override that can be added to MOD_CONF.txt file. These overrides change the quality of assets that are loaded into the game. The game will either load the High Definition (HD) or original low quality assets. This is required because, by default, the assets in the Dark Forces Remaster skip texture paletting and only show the HD version of the texture even if it doesn't fit the modded level. Most of the time you will never have to deal with this but some custom maps that use the GROMAS, JABSHIP, SEWERS or TALAY palettes will look strange in the remaster.

[[File:MOD CONF HD.png|center|thumb]]
For now, lets go over the structure of the HD overrides. Just like before, you add the JSON overrides to MOD_CONF.txt like before. The idea is that you can specify whether to show HD or non HD versions of the PDA menu and the Mission Briefings. Additionally, you can specify per level, which textures you can override to show the non-HD versions instead of the HD versions. The asset types you can override are '''BMs''' (Textures), '''FMEs''' (Frames - Ex: Ammo Pick up) , WAX (Sprites like enemy stormtroopers) .

For each asset type you would list the asset that should show the '''original''' version instead of the HD version. So if you want to show the original low-quality version of '''GPDIRTRD.BM''' you would add it to the list of BMs.
{
"HD_PDA": false,
"HD_BRIEF": false,
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]
}
}

Here is the low quality version of the '''GPDIRTRD.BM'''. If this override is added to MOD_CONF.txt then Dark Forces Remaster and TFE will show the original low quality version.
[[File:GPDIRTD LOW.png|center|thumb]]
If you remove the texture from the list it will show the default high-res version like the one below.
[[File:GPDIRTRD HIGH RES.png|center|thumb]]
The same concept works for FME and WAX assets. Just add them to the list of assets.

==== HD override details ====
Here are the '''true''' or '''false''' overrides for high resolution PDA or briefing. Both the Dark Forces Remaster and TFE will process these settings.
HD_PDA - Display the original or the high resolution version of the PDA. This is useful for custom imperial codes ('''true''' or '''false''')
HD_BRIEF - Display the original or the high resolution version of the Mission Briefing ('''true''' or '''false''').
Then we have a list of levels that should be overrides. Just like before you would write the name of the mission like SECBASE.LEV or TALAY.LEV and then list the types of assets that should show the low quality versions. The asset lists can be BMs FMEs or WAXs and are comma separated surrounded by brackets.
<level_name>.LEV - Name of Level to override HD assets. Can be SECBASE.LEV, TALAY.LEV etc...
<asset_type> - Must be either BM, WAX or FME.
An example is below for mission '''SECBASE.LEV'''
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]

When you add this override, it will show the low-quality version of textures '''GPDIRTRD.BM, SPSEWGE3.BM''' and '''GPMINE1X.BM''' from the BM list'''.''' It will also display the low-quality version of '''GFPIPEIS1.FME''' frame in the FME list. Finally, the Kell Dragon will be of low quality due to '''KELL.WAX''' being added to the WAX list.

Putting it altogether your MOD_CONF may look like this. Don't forget to ALWAYS check that you do not have any typos and validate with this website -->https://jsonlint.com/
{
"TFE_VERSION" : 1,
"TFE_OVERRIDES": {
"levelOverrides": {
"SECBASE.LEV": {
"pistol": false,
"rifle": true,
"power": 300,
"detonator": 5,
"shields": 150
},
"TALAY.LEV": {
"bryarOnly" : true,
"lives": 1
}
}
},
"HD_PDA": false,
"HD_BRIEF": false,
"SECBASE.LEV" : {
"BM": [
"GPDIRTRD.BM",
"SPSEWGE3.BM",
"GPMINE1X.BM"
],
"FME": [
"GFPIPES1.FME"
],
"WAX": [
"KELL.WAX"
]
}
}
Remember, if you are stuck or confused somewhere ask in the DF-21 [https://discord.gg/6T9NvMh2MC Discord] .

Level Script API

2025-03-23T06:53:25Z

Jerethk: /* Methods */

Level Script API

2025-03-23T06:38:47Z

Jerethk:

Dark Forces Wiki

2025-03-23T06:24:33Z

Jerethk: /* TFE Scripting */

<div style="text-align: center; font-size: x-large; padding: 1em;">[[File:WikiLogo.png|center|frameless|561x561px]]'''Welcome to the {{SITENAME}}!'''</div>

This community is dedicated to the 1995 game ''Star Wars: Dark Forces'' with an emphasis on modding and map making .

If you would like to contribute please create an account and help expand this wiki.

=== Dark Forces Editors ===

# '''[[WDFUSE]]''' - ('''The original Dark Forces Editor)'''
# '''[[TFE-EDITOR]]''' - '''(The Force Engine Editor)'''
# '''[https://df-21.net/downloads/utilities.php CYBERDARK] - (Obsolete)'''

=== How To Guides ===
* [https://df-21.net/wiki/?title=DF-21_Mission_Components Submitting DF-21 Missions]
* [https://df-21.net/wiki/?title=Converting_Classic_Maps Converting Old DF-21 Missions]
* [https://df-21.net/wiki/?title=How_To:_Good_MIDI How to get good sounding MIDI in Dark Forces]
* [https://df-21.net/wiki/?title=WAX_File_Generator How to generate an Enemy WAX file with Blender]]
* [https://df-21.net/wiki/?title=Blender_3DO_Guide How to create a 3DO file with Blender]]
* [[Level creation tips]]

=== Dark Forces Reference ===
* [[Dark Forces Unofficial Specifications]]
* [[Dark Forces Remaster Unofficial Specs]]

* [[Teleporter Basic]]
* [[VUE Camera transforms]]

* [[Logics and AI reference]]
* [[Weapons reference]]

=== The Force Engine Reference ===
* [[TFE_Mod_Overrides|Mod Overrides with MOD_CONF]]
* [[TFE Custom Logics]]
* [[TFE Projectile Data]]
* [[TFE Pickup Data]]
* [[TFE Weapon Data]]

==== TFE Scripting ====
* [[TFE Level Script]]
* [[Math Script API]]
* [[System Script API]]
* [[Level Script API]]
* [[Game Script API]]
* [[Player Script API]]

* [[Script Sector]]
* [[Script Wall]]
* [[Script Object]]
* [[Script Texture]]
* [[Script Elevator]]

=== Vault ===
* [[:Category:Demo Assets|Assets included with the Dark Forces demo]]

[[Category:{{SITENAME}}]]

Level Script API

2025-03-23T06:23:55Z

Jerethk: Created page with "== Properties == === minLayer === * Get only * Gets the minimum map layer (signed integer) * Usage example: <code>int i = level.minLayer;</code> === maxLayer === * Get only * Gets the maximum map layer (signed integer) * Usage example: <code>int i = level.maxLayer;</code> === sectorCount === * Get only * Gets the total count of sectors (signed integer) * Usage example: <code>int i = level.sectorCount</code> === secretCount === * Get only * Gets the total count of secr..."

== Properties ==
=== minLayer ===
* Get only
* Gets the minimum map layer (signed integer)
* Usage example: <code>int i = level.minLayer;</code>

=== maxLayer ===
* Get only
* Gets the maximum map layer (signed integer)
* Usage example: <code>int i = level.maxLayer;</code>

=== sectorCount ===
* Get only
* Gets the total count of sectors (signed integer)
* Usage example: <code>int i = level.sectorCount</code>

=== secretCount ===
* Get only
* Gets the total count of secrets (signed integer)
* Usage example: <code>int i = level.secretCount</code>

=== texturetCount ===
* Get only
* Gets the total count of textures (signed integer)
* Usage example: <code>int i = level.textureCount</code>

== Functions ==
=== getSector ===

Dark Forces Wiki

2025-03-23T06:13:37Z

Jerethk: /* TFE Scripting */

<div style="text-align: center; font-size: x-large; padding: 1em;">[[File:WikiLogo.png|center|frameless|561x561px]]'''Welcome to the {{SITENAME}}!'''</div>

This community is dedicated to the 1995 game ''Star Wars: Dark Forces'' with an emphasis on modding and map making .

If you would like to contribute please create an account and help expand this wiki.

=== Dark Forces Editors ===

# '''[[WDFUSE]]''' - ('''The original Dark Forces Editor)'''
# '''[[TFE-EDITOR]]''' - '''(The Force Engine Editor)'''
# '''[https://df-21.net/downloads/utilities.php CYBERDARK] - (Obsolete)'''

=== How To Guides ===
* [https://df-21.net/wiki/?title=DF-21_Mission_Components Submitting DF-21 Missions]
* [https://df-21.net/wiki/?title=Converting_Classic_Maps Converting Old DF-21 Missions]
* [https://df-21.net/wiki/?title=How_To:_Good_MIDI How to get good sounding MIDI in Dark Forces]
* [https://df-21.net/wiki/?title=WAX_File_Generator How to generate an Enemy WAX file with Blender]]
* [https://df-21.net/wiki/?title=Blender_3DO_Guide How to create a 3DO file with Blender]]
* [[Level creation tips]]

=== Dark Forces Reference ===
* [[Dark Forces Unofficial Specifications]]
* [[Dark Forces Remaster Unofficial Specs]]

* [[Teleporter Basic]]
* [[VUE Camera transforms]]

* [[Logics and AI reference]]
* [[Weapons reference]]

=== The Force Engine Reference ===
* [[TFE_Mod_Overrides|Mod Overrides with MOD_CONF]]
* [[TFE Custom Logics]]
* [[TFE Projectile Data]]
* [[TFE Pickup Data]]
* [[TFE Weapon Data]]

==== TFE Scripting ====
* [[TFE Level Script]]
* [[Math Script API]]
* [[Level Script API]]
* [[Game Script API]]
* [[Player Script API]]

* [[Script Sector]]
* [[Script Wall]]
* [[Script Object]]
* [[Script Texture]]
* [[Script Elevator]]

=== Vault ===
* [[:Category:Demo Assets|Assets included with the Dark Forces demo]]

[[Category:{{SITENAME}}]]

Dark Forces Wiki

2025-03-23T06:11:32Z

Jerethk: /* The Force Engine Reference */ Add links to scripting articles. Most are still redlinks

<div style="text-align: center; font-size: x-large; padding: 1em;">[[File:WikiLogo.png|center|frameless|561x561px]]'''Welcome to the {{SITENAME}}!'''</div>

This community is dedicated to the 1995 game ''Star Wars: Dark Forces'' with an emphasis on modding and map making .

If you would like to contribute please create an account and help expand this wiki.

=== Dark Forces Editors ===

# '''[[WDFUSE]]''' - ('''The original Dark Forces Editor)'''
# '''[[TFE-EDITOR]]''' - '''(The Force Engine Editor)'''
# '''[https://df-21.net/downloads/utilities.php CYBERDARK] - (Obsolete)'''

=== How To Guides ===
* [https://df-21.net/wiki/?title=DF-21_Mission_Components Submitting DF-21 Missions]
* [https://df-21.net/wiki/?title=Converting_Classic_Maps Converting Old DF-21 Missions]
* [https://df-21.net/wiki/?title=How_To:_Good_MIDI How to get good sounding MIDI in Dark Forces]
* [https://df-21.net/wiki/?title=WAX_File_Generator How to generate an Enemy WAX file with Blender]]
* [https://df-21.net/wiki/?title=Blender_3DO_Guide How to create a 3DO file with Blender]]
* [[Level creation tips]]

=== Dark Forces Reference ===
* [[Dark Forces Unofficial Specifications]]
* [[Dark Forces Remaster Unofficial Specs]]

* [[Teleporter Basic]]
* [[VUE Camera transforms]]

* [[Logics and AI reference]]
* [[Weapons reference]]

=== The Force Engine Reference ===
* [[TFE_Mod_Overrides|Mod Overrides with MOD_CONF]]
* [[TFE Custom Logics]]
* [[TFE Projectile Data]]
* [[TFE Pickup Data]]
* [[TFE Weapon Data]]

==== TFE Scripting ====
* [[TFE Level Script]]
* [[Math Script API]]
* [[Game Script API]]
* [[Player Script API]]

* [[Script Sector]]
* [[Script Wall]]
* [[Script Object]]
* [[Script Texture]]
* [[Script Elevator]]

=== Vault ===
* [[:Category:Demo Assets|Assets included with the Dark Forces demo]]

[[Category:{{SITENAME}}]]