Renamed all metarule functions with mf_ prefix

* Fixed NPCs being unable to select a burst attack mode if the line of
fire was blocked.

* Changed the return point of combat_ai_hook_FleeFix to run
ai_check_drugs_ first.

Changed the debug message about missing art file for critters to be
displayed in game only when in sfall debugging mode.

README.md

@@ -1,8 +1,8 @@
 # sfall
 
-A set of engine modifications for the classic game Fallout 2 in form of a DLL, which modifies executable in memory without changing anything in EXE file itself.  
+A set of engine modifications for the classic game Fallout 2 in form of a DLL, which modifies executable in memory without changing anything in EXE file itself.
 
-Engine modifications include:   
+**Engine modifications include:**
 - Better support for modern operating systems
 - Externalizing many settings like starting map and game time, skills, perks, critical hit tables, books, etc.
 - Bug fixes
@@ -10,7 +10,7 @@ Engine modifications include:
 - Extended scripting capabilities for modders (many new opcodes to control sfall features as well as previously unavailable vanilla engine functions)
 
 
-Original author: timeslip  
+Original author: timeslip
 
-Original description: A set of engine modifications for the classic game Fallout 2 by Interplay. Includes fixes for bugs in the original engine, allows fallout to run correctly on modern operating systems, and adds additional features for modders.  
+Original description: A set of engine modifications for the classic game Fallout 2 by Interplay. Includes fixes for bugs in the original engine, allows fallout to run correctly on modern operating systems, and adds additional features for modders.
 

artifacts/config_files/Perks.ini

@@ -7,6 +7,30 @@
 ; have an additional NoHardcode option in this file which can
 ; be used to remove their hardcoded effects, and add new stat/skill effects
 
+[PerksTweak]
+;Change the penalty distance and distance bonus for 'Weapon Scope Range' weapon perk
+;0 - no penalty, 8 - default penalty
+WeaponScopeRangePenalty=8
+;2 - no bonus, 5 - default bonus
+WeaponScopeRangeBonus=5
+
+;Changes the distance bonus for 'Weapon Long Range' weapon perk
+;2 - no bonus, 4 - default bonus
+WeaponLongRangeBonus=4
+
+;Changes the hit chance bonus for 'Weapon Accurate' weapon perk
+;0 - no bonus,  200 - maximum bonus, 20 - default bonus
+WeaponAccurateBonus=20
+
+;Changes the strength bonus for 'Weapon Handling' perk
+;0 - no bonus,  10 - maximum bonus, 3 - default bonus
+WeaponHandlingBonus=3
+
+;##############################################################################
+[Perks]
+;Set to 1 to enable the modifications for perks
+Enable=0
+
 ;Name=The name of the perk (max 63 characters)
 ;Desc=The description of the perk (max 255 characters)
 ;Image=The line number (0-indexed) of the corresponding FRM in skilldex.lst
@@ -35,6 +59,7 @@
 
 ;If the value is set to -99999, the variable will be ignored (similar to comment out that line)
 
+;##############################################################################
 ;This is a modification to perk 119
 [119]
 Name=Example
@@ -57,6 +82,11 @@ INT=0
 AGL=0
 LCK=0
 
+;##############################################################################
+[Traits]
+;Set to 1 to enable the modifications for traits
+Enable=0
+
 ;This is a modification to trait 0
 [t0]
 NoHardcode=0

artifacts/example_mods/ComputeDamage/gl_compute_damage.ssl

@@ -0,0 +1,206 @@
+/*
+   Example algorithm of how the game engine calculates combat damage
+*/
+
+#include "..\headers\define.h"
+#include "..\headers\command.h"
+#include "..\headers\sfall\sfall.h"
+#include "..\headers\sfall\define_extra.h"
+
+procedure start;
+procedure compute_damage_F2;
+procedure item_w_damage_hook;
+procedure item_w_subtype(variable weapon, variable hit_mode);
+procedure get_ammo_value(variable weapon, variable param);
+
+variable item_w_damage;
+
+procedure start begin
+   if game_loaded then begin
+      register_hook_proc(HOOK_COMBATDAMAGE, compute_damage_F2);
+      register_hook_proc(HOOK_ITEMDAMAGE, item_w_damage_hook);
+   end
+end
+
+procedure compute_damage_F2 begin
+   variable dmg_type, weapon_perk, dmg_thresh, dmg_resist, weapon_subtype, bonus_ranged, difficulty, i, dmg_mult, dmg_div, damage;
+   variable target, flags, knockback, amount;
+
+   variable
+      ctdTarget        := get_sfall_arg,
+      ctdSource        := get_sfall_arg,
+      amountTarget     := get_sfall_arg,
+      amountSource     := get_sfall_arg,
+      flagsTarget      := get_sfall_arg,
+      flagsSource      := get_sfall_arg,
+      weapon           := get_sfall_arg,
+      bodypart         := get_sfall_arg,
+      damageMultiplier := get_sfall_arg,
+      rounds           := get_sfall_arg,
+      amountKnockback  := get_sfall_arg,
+      hit_mode         := get_sfall_arg;
+
+   if (flagsSource bwand DAM_HIT) then begin
+      target := ctdTarget;
+      flags := flagsTarget;
+      knockback := 1;
+   end else begin
+      target := ctdSource;
+      flags := flagsSource;
+      knockback := 0;
+   end
+
+   //amount := 0;
+   if target and (obj_type(target) == OBJ_TYPE_CRITTER) then begin
+      if weapon then begin
+         dmg_type := weapon_dmg_type(weapon);
+         weapon_perk := get_proto_data(obj_pid(weapon), PROTO_WP_PERK);
+      end else begin
+         dmg_type := DMG_normal_dam;
+         weapon_perk := -1;
+      end
+
+      dmg_thresh := get_critter_stat(target, STAT_dmg_thresh + dmg_type);
+      dmg_resist := get_critter_stat(target, STAT_dmg_resist + dmg_type);
+
+      if (flags bwand DAM_BYPASS) and (dmg_type != DMG_emp) then begin
+         dmg_thresh := dmg_thresh * 20 / 100;
+         dmg_resist := dmg_resist * 20 / 100;
+      end else begin
+         if (weapon_perk == PERK_weapon_penetrate)
+            or (hit_mode == ATKTYPE_PALMSTRIKE or hit_mode == ATKTYPE_PIERCINGSTRIKE
+            or hit_mode == ATKTYPE_HOOKKICK or hit_mode == ATKTYPE_PIERCINGKICK) then
+            dmg_thresh := dmg_thresh * 20 / 100;
+
+         if ctdSource == dude_obj and has_trait(TRAIT_TRAIT, ctdSource, TRAIT_finesse) then
+            dmg_resist += 30;
+      end
+
+      weapon_subtype := item_w_subtype(weapon, hit_mode); // item_w_subtype_
+      if (ctdSource != dude_obj) or (weapon_subtype != WEAPON_TYPE_GUNS) then
+         bonus_ranged := 0;
+      else
+         bonus_ranged := has_trait(TRAIT_PERK, ctdSource, PERK_bonus_ranged_damage) * 2;
+
+      difficulty := 100;
+      if (has_trait(TRAIT_OBJECT, ctdSource, OBJECT_TEAM_NUM) != has_trait(TRAIT_OBJECT, dude_obj, OBJECT_TEAM_NUM)) then begin
+         if (combat_difficulty == 0) then
+            difficulty := 75;
+         else if (combat_difficulty == 2) then
+            difficulty := 125;
+      end
+
+      // F2 default start
+      // Damage = (1 - (DR_armor + DR_ammo_adjust) * (((raw_damage * (dmg_mult * damageMultiplier)) / dmg_div) - dmg_thresh)
+      dmg_resist += get_ammo_value(weapon, PROTO_AM_DR_MOD); // item_w_dr_adjust_ (DR Adjust %)
+      if (dmg_resist < 100) then begin
+         if (dmg_resist < 0) then dmg_resist := 0;
+
+         dmg_mult := damageMultiplier * get_ammo_value(weapon, PROTO_AM_DMG_MULT); // item_w_dam_mult_ (Dmg mod A)
+         dmg_div := get_ammo_value(weapon, PROTO_AM_DMG_DIV); // item_w_dam_div_ (Dmg mod B)
+
+         for (i := 1; i <= rounds; i++) begin
+            damage := (item_w_damage + bonus_ranged) * dmg_mult; // item_w_damage_ (raw_damage)
+            if dmg_div then damage /= dmg_div;
+
+            damage := (((damage / 2) * difficulty) / 100) - dmg_thresh;
+            if (damage > 0) then begin
+               damage := damage - ((damage * dmg_resist) / 100); // reduce damage by the percentage of DR_armor + DR_Ammo
+               if (damage > 0) then amount += damage;
+            end
+         end
+      end
+      // F2 default end
+
+      if (ctdSource == dude_obj) then begin
+         if has_trait(TRAIT_PERK, ctdSource, PERK_living_anatomy_perk) and (critter_kill_type(ctdTarget) != KILL_TYPE_robot_kills)
+            and (critter_kill_type(ctdTarget) != KILL_TYPE_alien_kills) then
+            amount += 5;
+         if has_trait(TRAIT_PERK, ctdSource, PERK_pyromaniac_perk) and (dmg_type == DMG_fire) then
+            amount += 5;
+      end
+
+      if knockback and ((get_flags(target) bwand FLAG_MULTIHEX) == 0)
+         and (dmg_type == DMG_explosion or weapon == 0 or weapon_subtype == WEAPON_TYPE_MELEE)
+         and ((get_proto_data(obj_pid(target), PROTO_CR_FLAGS) bwand CFLG_NOKNOCKDOWN) == 0) then begin // critter_flag_check_
+         damage := 0;
+         if (target == dude_obj) and has_trait(TRAIT_PERK, target, PERK_stonewall_perk) then begin
+            damage := 1;
+            if (random(0, 100) < 50) then knockback := 0;
+         end
+         if knockback then begin
+            if (weapon_perk == PERK_weapon_knockback) then
+               amountKnockback := amount / 5;
+            else
+               amountKnockback := amount / 10;
+
+            if damage then amountKnockback /= 2;
+         end
+      end
+   end
+
+   if (flagsSource bwand DAM_HIT) then begin
+      display_msg("amountTarget = " + amountTarget+ ", amount = " + amount);
+      amountTarget := amount;
+      flagsTarget := flags;
+   end else begin
+      display_msg("amountSource = " + amountSource+ ", amount = " + amount);
+      amountSource := amount;
+      flagsSource := flags;
+   end
+
+   set_sfall_return(amountTarget);
+   set_sfall_return(amountSource);
+   set_sfall_return(flagsTarget);
+   set_sfall_return(flagsSource);
+   set_sfall_return(amountKnockback);
+end
+
+procedure item_w_damage_hook begin
+   variable
+      item_w_damage_min := get_sfall_arg,
+      item_w_damage_max := get_sfall_arg;
+      //weapon := get_sfall_arg,
+      //source := get_sfall_arg,
+      //hit_mode := get_sfall_arg,
+      //isMelee := get_sfall_arg;
+
+   item_w_damage := (item_w_damage_min + (item_w_damage_max - item_w_damage_min) / 2);
+   display_msg("item_w_damage_ = " + item_w_damage);
+
+   set_sfall_return(item_w_damage);
+end
+
+procedure item_w_subtype(variable weapon, variable hit_mode) begin
+   variable attack_mode, type := WEAPON_TYPE_UNARMED;
+
+   if weapon and (hit_mode <= ATKTYPE_RWEP2) then begin
+      attack_mode := (get_proto_data(obj_pid(weapon), PROTO_IT_FLAGS));
+
+      if (hit_mode == ATKTYPE_LWEP2) or (hit_mode == ATKTYPE_RWEP2) then
+         attack_mode := (attack_mode bwand 0xF0) / 16; // shift 4 bits to the right
+      else
+         attack_mode := (attack_mode bwand 0x0F);
+
+      if (attack_mode > ATKMODE_PRI_THROW) then
+         type := WEAPON_TYPE_GUNS;
+      else if (attack_mode == ATKMODE_PRI_THROW) then
+         type := WEAPON_TYPE_THROWN;
+      else if (attack_mode > ATKMODE_PRI_KICK) then
+         type := WEAPON_TYPE_MELEE;
+   end
+
+   return type;
+end
+
+procedure get_ammo_value(variable weapon, variable param) begin
+   variable pid := -1, value := 0; // default DR value
+
+   if weapon then begin
+      pid := get_weapon_ammo_pid(weapon);
+      if (pid > -1) then value := get_proto_data(pid, param);
+   end
+   if (pid == -1 and param != PROTO_AM_DR_MOD) then value := 1; // default value for Mult/Div
+
+   return value;
+end

artifacts/example_mods/GlobalShaders/global.fx

@@ -0,0 +1,116 @@
+// Status: WIP
+
+texture bloomMap;
+sampler s0;
+
+sampler BloomSampler : samplerstate
+{
+	Texture = bloomMap;
+	MinFilter = Linear;
+	MagFilter = Linear;
+	AddressU = Clamp;
+	AddressV = Clamp;
+};
+
+// pseudo gauss blur
+static const float2 offsets[12] = {
+	-0.326212, -0.405805,
+	-0.840144, -0.073580,
+	-0.695914,  0.457137,
+	-0.203345,  0.620716,
+	 0.962340, -0.194983,
+	 0.473434, -0.480026,
+	 0.519456,  0.767022,
+	 0.185461, -0.893124,
+	 0.507431,  0.064425,
+	 0.896420,  0.412458,
+	-0.321940, -0.932615,
+	-0.791559, -0.597705,
+};
+
+float w;
+float h;
+static const float2 resolution = float2(w, h);
+
+// blur setting
+static const float blurFalloff = 8;
+static const float sharpness = 4;
+
+float4 AdjustSaturation(float4 color, float saturation) {
+	float grey = dot(color, float3(0.3, 0.59, 0.11));
+
+	return lerp(grey, color, saturation);
+}
+
+float Brightness(float3 color)
+{
+	return color.r * color.g - 0.75 * color.b;
+}
+
+float3 BlurFunction(float2 uv, float brightness, inout float totalWeight)
+{
+	float3 pointColor =(tex2Dlod(s0, float4(uv, 0, 0)).rgb);
+	float diff = abs(brightness - Brightness(pointColor));
+	float weight = exp2(-0.25 * blurFalloff - diff * sharpness);
+	totalWeight += weight;
+
+	return pointColor * weight;
+}
+
+float4 BlurPS(float2 uv : TEXCOORD0, uniform float2 delta) : COLOR0
+{
+	float3 sumColor = (tex2D(s0, uv).rgb);
+	float totalWeight = 1;
+	float brightness = Brightness(sumColor);
+	delta *= (1 / resolution);
+	float radius = 1;
+
+		float2 pointUV = uv + delta * radius;
+		  sumColor += BlurFunction(pointUV, brightness, totalWeight);
+		pointUV = uv - delta * radius;
+		  sumColor += BlurFunction(pointUV, brightness, totalWeight);
+
+	return float4((sumColor / totalWeight),1);
+//	return AdjustSaturation(Color, 0.5);
+}
+
+float4 BloomT(float2 texCoord : TEXCOORD0) : COLOR0 {
+	float4 c = tex2D(s0, texCoord);
+	float BloomThreshold = 0.2;
+
+	return saturate((c - BloomThreshold) / (1 - BloomThreshold));
+}
+
+float4 Bloom(float4 color : COLOR0, float2 texCoord : TEXCOORD0) : COLOR0 {
+	float BaseIntensity = 1.0;
+	float BaseSaturation = 1;
+	float BloomIntensity = 1; // 0.4
+	float BloomSaturation = 0.5;
+	float BlurPower = 0.01;
+	float BloomThreshold = 0.5;
+
+	float4 original = tex2D(s0, texCoord);
+
+	// blur
+	float4 sum = tex2D(s0, texCoord);
+	for(int i = 0; i < 12; i++){
+		sum += tex2D(s0, texCoord + BlurPower * offsets[i]);
+	}
+	sum /= 13;
+
+	original = AdjustSaturation(original, BaseSaturation) * BaseIntensity;
+	sum = AdjustSaturation(sum, BloomSaturation) * BloomIntensity;
+
+	sum = saturate((sum - BloomThreshold) / (1 - BloomThreshold));
+
+	return sum + original;
+//	return sum;
+}
+
+technique Blur
+{
+//	pass P2 { PixelShader = compile ps_2_0 BloomT(); }
+//	pass P3 { PixelShader = compile ps_2_0 Bloom();  }
+	Pass P0 { PixelShader = compile ps_3_0 BlurPS(float2(1, 0)); }
+	Pass P1 { PixelShader = compile ps_3_0 BlurPS(float2(0, 1)); }
+}

artifacts/example_mods/ItemHighlight_Lite/main.h

@@ -1,30 +1,48 @@
+#ifndef MAIN_H
+#define MAIN_H
 
 #include "..\scripting\headers\sfall.h"
 #include "..\scripting\headers\define_lite.h"
 #include "..\scripting\headers\define_extra.h"
-
+#include "..\scripting\headers\dik.h"
+/*
 #include "..\scripting\headers\lib.arrays.h"
 #include "..\scripting\headers\lib.strings.h"
-// #include "..\scripting\headers\lib.inven.h"
+#include "..\scripting\headers\lib.inven.h"
+*/
 
 variable ini := "sfall-mods.ini";
 variable translationIni;
 
-// Gets the integer value from ini
+// Gets the integer value from the specified ini
+procedure GetIniConfig(variable section, variable key, variable def, variable inifile) begin
+   variable val := get_ini_setting(inifile + "|" + section + "|" + key);
+   if val == -1 then val := def;
+   return val;
+end
+
+// Gets the string value from the specified ini
+procedure GetIniConfigStr(variable section, variable key, variable def, variable inifile) begin
+   variable val := get_ini_string(inifile + "|" + section + "|" + key);
+   if val == -1 or val == "" then val := def;
+   return val;
+end
+
+// Gets the integer value from sfall-mods.ini
 procedure GetConfig(variable section, variable key, variable def) begin
    variable val := get_ini_setting(ini + "|" + section + "|" + key);
    if val == -1 then val := def;
    return val;
 end
 
-// Gets the string value from ini
+// Gets the string value from sfall-mods.ini
 procedure GetConfigStr(variable section, variable key, variable def) begin
    variable val := get_ini_string(ini + "|" + section + "|" + key);
    if val == -1 or val == "" then val := def;
    return val;
 end
 
-// Gets the value from ini as a temp array of strings
+// Gets the value from sfall-mods.ini as a temp array of strings
 procedure GetConfigList(variable section, variable key) begin
    variable val := get_ini_string(ini + "|" + section + "|" + key);
    if val == -1 or val == "" then return [];
@@ -32,7 +50,7 @@ procedure GetConfigList(variable section, variable key) begin
    return string_split(val, ",");
 end
 
-// Gets the value from ini as a temp array of ints
+// Gets the value from sfall-mods.ini as a temp array of ints
 procedure GetConfigListInt(variable section, variable key) begin
    variable arr, i, item;
 
@@ -53,5 +71,7 @@ procedure Translate(variable id, variable def) begin
 end
 
 procedure InitConfigs begin
-   translationIni := GetConfigStr("Main", "TranslationsINI", "./Translations.ini");
+   translationIni := GetIniConfigStr("Main", "TranslationsINI", "Translations.ini", "ddraw.ini");
 end
+
+#endif

artifacts/example_mods/StealCheat/readme.txt

@@ -1,5 +1,5 @@
-Master Theif cheat for fallout 2 by phobos2077
-----------------------------------------
+Master Thief cheat for fallout 2 by phobos2077
+----------------------------------------------
 
 - forces all steal attempts to succeed
 

artifacts/example_mods/TakeAllHotkey/gl_takeallkey.ssl

@@ -1,20 +0,0 @@
-procedure start;
-// adjust include paths if needed
-#include "..\..\scripting_docs\headers\sfall.h"
-#include "..\..\scripting_docs\headers\dik.h"
-
-procedure start begin
-   if game_loaded then begin
-      register_hook(HOOK_KEYPRESS);
-   end else begin
-      variable
-         event := get_sfall_arg,
-         keyDX := get_sfall_arg;
-
-      if (event == 1) and (keyDX == DIK_SEMICOLON) then begin
-         tap_key(DIK_CAPITAL);
-         tap_key(DIK_A);
-         tap_key(DIK_CAPITAL);
-      end
-   end
-end

artifacts/example_mods/TakeAllHotkey/readme.txt

@@ -1,9 +0,0 @@
-"Take All" Hotkey mod for Fallout 2 by NovaRain
-----------------------------------------
-
-- makes pressing the semicolon key send an uppercase A after a semicolon.
-- Note: the uppercase A (shift + A if Caps Lock is off) is the built-in hotkey for the TAKE ALL button on the loot screen.
-
-To use, copy *.int file to your scripts folder.
-
-This mod is a simple example of how you can use HOOK_KEYPRESS hooks.

artifacts/example_mods/UIHotkeys/gl_uihotkeys.ssl

@@ -0,0 +1,54 @@
+/*
+
+UI Hotkeys mod for Fallout 2 by NovaRain
+----------------------------------------
+
+- closes some game interfaces by pressing their hotkeys again:
+  * 'I' key for Inventory
+  * 'S' key for Skilldex
+  * 'Z' key for Pip-Boy
+
+- extends the functionality of the 'Space' key (Caps Lock must be off):
+  * takes all items in the loot screen
+  * makes the offer in the barter screen
+
+Requires sfall 3.5 or higher
+
+*/
+
+#include "..\headers\sfall\sfall.h"
+#include "..\headers\sfall\dik.h"
+
+procedure start;
+
+procedure start begin
+   if game_loaded then begin
+      register_hook(HOOK_KEYPRESS);
+   end else begin
+      variable
+         event := get_sfall_arg,
+         keyDX := get_sfall_arg,
+         mode;
+
+      if (event) then begin
+         mode := get_game_mode;
+         if (mode bwand COUNTERWIN) then return; // new mode from sfall 4.2/3.8.20
+         if (keyDX == DIK_I and (mode bwand INVENTORY)) then begin
+            tap_key(DIK_ESCAPE);
+         end else if (keyDX == DIK_S and (mode bwand SKILLDEX)) then begin
+            tap_key(DIK_ESCAPE);
+         end else if (keyDX == DIK_Z and (mode bwand PIPBOY)) then begin
+            tap_key(DIK_ESCAPE);
+         end else if (keyDX == DIK_SPACE) then begin
+            if (mode bwand INTFACELOOT) then begin
+               tap_key(DIK_CAPITAL);
+               tap_key(DIK_A);
+               tap_key(DIK_CAPITAL);
+            end else if (mode bwand BARTER) then begin
+               play_sfx("IB2P1XX1");
+               tap_key(DIK_M);
+            end
+         end
+      end
+   end
+end

artifacts/example_mods/UIHotkeys/readme.txt

@@ -0,0 +1,22 @@
+UI Hotkeys mod for Fallout 2 by NovaRain
+----------------------------------------
+
+- closes some game interfaces by pressing their hotkeys again:
+  * 'I' key for Inventory
+  * 'S' key for Skilldex
+  * 'Z' key for Pip-Boy
+
+- extends the functionality of the 'Space' key (Caps Lock must be off):
+  * takes all items in the loot screen
+  * makes the offer in the barter screen
+
+- Note:
+  * the uppercase 'A' (shift + A if Caps Lock is off) is the built-in hotkey for the TAKE ALL button on the loot screen
+  * the lowercase 'm' is the built-in hotkey for the OFFER button on the barter screen
+
+
+Requires sfall 3.5 or higher
+
+To use, copy gl_uihotkeys.int to your scripts folder.
+
+This mod is a simple example of how you can use HOOK_KEYPRESS hooks.

artifacts/scripting/arrays.txt

@@ -155,7 +155,7 @@ Example:
 - creates permanent array (but not "saved")
 - if size is >= 0, creates list with given size
 - if size == -1, creates map (associative array)
-- if size == -1 and flags == 2, creates a "lookup" map in which the values of existing keys are read-only and can't be updated.
+- if size == -1 and flags == 2, creates a "lookup" map (associative array) in which the values of existing keys are read-only and can't be updated.
 This type of array allows you to store a zero (0) key value
 - NOTE: in earlier versions (up to 4.1.3/3.8.13) the second argument is not used, just use 0
 - returns arrayID (valid until array is deleted)
@@ -212,9 +212,11 @@ use macros sort_array, sort_array_reverse, reverse_array, shuffle_array from sfa
 - always returns 0
 
 > void save_array(mixed key, int arrayID):
+- makes the array saveable; it will be saved in sfallgv.sav file when saving the game
 - arrayID is associated with given "key"
 - array becomes permanent (if it was temporary) and "saved"
 - key can be of any type (int, float or string)
+- if you specify 0 as the key for the array ID, it will make the array "unsaved"
 
 > int load_array(mixed key):
 - load array from savegame data by the same key provided in "save_array"

artifacts/scripting/compiler/optimization.txt

@@ -0,0 +1,99 @@
+The executation speed of scripts is not typically important in an unmodded game, given the difference in performance between a modern computer and what Fallout was designed for. When you start adding mods to the mix there's the potential for problems again, since sfall's global script system means that you can have a large amount of scripts being run every single frame.
+
+======================
+=== sslc -O option ===
+======================
+
+The sfall build of sslc supports a -O command line option to perform an optimization pass over the generated code. This isn't a magic make-my-code-go-faster bullet; most of what it does is very limited in scope. It's primary purpose was to strip out the procedures and variables which get automatically pulled into every script that includes define.h, whether you use them or not, and to do something about the additional variables that get created by foreach loops.
+
+There are several levels of optimization available:
+-O1 - Basic, only removes unreferenced globals variables and procedures, code itself remains untouched.
+-O2 - Full, most code optimizations are on, but only those that were tested on complex scripts.
+-O3 - Experimental, provides most efficiency, but tend to break some complex code due to bugs.
+
+The following optimizations are performed:
+
+> constant expression folding: if an expression depends only on values which are known at compile time, then the expression is replaced by its result.
+
+a:=2+2; -> a:=4;
+
+> constant variable initialization: All variables are initialised to some value, ('0', if you don't specify anything else,) so sslc attempts to make use of that fact to remove the first assignment to a variable if the first assignment is a constant expression.
+
+variable a;  -> variable a:=4;
+a:=4;        -> 
+
+> constant propagation: checks for values assigned to variables which can be computed at compile time, and replaces relevent references to the symbol by the constant. The original store is not removed by this optimization. Global variables are considered for this optimization only if they are not marked import or export, and are not assigned to anywhere in the script.
+
+a:=4     -> a:=4
+foo(a);  -> foo(4);
+
+> dead code removal: Checks for and removes code which cannot be reached, either because it is hidden behind a return or because the argument to an if statement can be computed at compile time.
+
+if 1 then begin        -> display_msg("foo");
+  display_msg("foo");  ->
+end else begin         ->
+  display_msg("bar");  ->
+end                    ->
+
+> unreferenced variable elimination: Checks for variables which are never referenced, and removes them. Also applies to global variables, as long as they are not marked for export.
+
+variable i, j, k;  -> variable i;
+i:=1;              -> i:=1;
+return;            -> return;
+
+> unreferenced procedure elimination: Checks for any procedures which are never called, and removes them.
+
+procedure foo begin return "foo"; end   -> procedure foo begin return "foo"; end
+procedure bar begin return "bar"; end   -> procedure start begin
+procedure start begin                   ->   display_msg(foo);
+  display_msg(foo);                     -> end
+end                                     ->
+
+> dead store removal: Removes variable assignments if the result of the variable is unused, and if the expression used to compute the value of the variable is provably free of side effects. (See 'pure' keyword)
+
+a:="moo";         -> a:="foo";
+a:="foo";         -> display_msg(a);
+display_msg(a);   ->
+a:="bar";         ->
+
+> store combination: Where there are two stores in a row to the same variable, the two expressions are combined.
+
+var1 := var2; -> var1 := var2 + var3;
+var1 += var3; -> 
+
+> variable combination: Where usage regions of variables do not overlap, combine the variables to provide additional candidates for unreferenced variable elimination. Very useful for scripts containing multiple foreach loops, which generate 2 or 3 hidden variables each.
+
+a:="foo";         -> a:="foo";
+display_msg(a);   -> display_msg(a);
+b:="bar";         -> a:="bar";
+display_msg(b);   -> display_msg(a);
+
+> namelist compression: Fallout stores the names of all file scope variables and procedures in a namelist which is saved into the .int. Any of these that are unreferenced can be removed, and the names of global variables can be modified to make them shorter.
+
+=============================
+=== writing your own code ===
+=============================
+
+Don't have global scripts running any more often that you need them to. Not everything needs to be run every single frame.
+
+Never concat constant strings with the '+' operator, as it forces the operation to be done at runtime. The compiler can cope with constant strings being placed next to each other without the need for a +, which results in far more efficient code as the combination is done at lex time.
+
+#define GLOB_PREFIX "ts__"                    -> #define GLOB_PREFIX "ts__"
+
+procedure start begin                         -> procedure start begin
+  set_sfall_global(GLOB_PREFIX + "foo1", 0);  ->   set_sfall_global(GLOB_PREFIX "foo1", 0);
+end                                           -> end
+
+
+Avoid function calls in while loops. function calls are expensive in comparison to variable lookups, so it's more efficient to move the function call out of the loop and store the result in a variable
+
+while i < len_array(array) do begin           -> tmp:= len_array(array);
+  ...                                         -> while i < tmp do begin
+end                                           ->   ...
+                                              -> end
+
+Mark functions with pure or inline where relevent.
+
+'pure' is a hint to the optimizer that a procedure has no side effects. (i.e. there's no way to tell that it's been called aside from its return value.) Pure procedures cannot modify global variables, or call any other procedure that isn't itself pure. Functions marked with pure can only be used in expressions (i.e. you cannot use the 'call <procedure>' syntax to call them.) If there are non-pure terms in an expression, it prevents that expression being considered for dead store removal. Where no such optimizations can be performed, or if optimization is disabled, marking a procedure with pure will have no effect on the compiled code.
+
+'inline' is an instruction to the compiler to replace calls to the marked procedure with a copy of the procedures code instead of having a seperate call. inlined procedures cannot use the 'return' command, cannot be predefined, and cannot be used as part of an expression. inlining if a procedure is only going to be called once is always a win, but if there are multiple calls to a procedure you will end up bloating the size of the generated code.

artifacts/scripting/compiler/sslc_readme.txt

@@ -0,0 +1,405 @@
+This is a modified copy of sslc, that has a few bugfixes from the original, that will recognise and compile the additional scripting functions provided by sfall, that can also understand some additional syntax, and that has an integrated preprocessor and optimizer.
+
+Unlike the original script compiler, this has not been compiled as a dos program. When using this in place of the original compile.exe but still using p.bat, you need to either get rid of the dos4gw.exe reference from p.bat or replace the original dos4gw.exe with the one in this archive.
+
+If you use fallout script editor, you can extract compile.exe and dos4gw.exe to its \binary folder, or extract them somewhere else and change your preferences in FSE to point there. FSE doesn't seem to be able to tell when errors occur when using this compiler though, so I'd recommend either using sfall's script editor instead or compiling by hand if possible.
+
+When compiling global or hook scripts for sfall 3.4 or below, you _must_ include the line 'procedure start;' before any #includes that define procedures to avoid a few weird problems. (this is no longer required starting from 3.5)
+
+This version of compiler was designed primarily for new sfall functions, but it can safely (and is recommended) to be used with non-sfall scripts as well, as long as you don't use any of the arrays syntax and any sfall scripting functions.
+
+The original unmodified sslc source is over here:
+http://www.teamx.ru/eng/files/srcs/index.shtml
+
+============================
+=== command line options ===
+============================
+
+-q  don't wait for input on error
+-n  no warnings
+-b  backward compatibility mode
+-l  no logo
+-p  preprocess source
+-O  optimize code (full, see optimization.txt)
+-O<N> set specific level of optimization (0 - off, 1 - basic, 2 - full, 3 - experimental)
+-d  print debug messages
+-D  output an abstract syntax tree of the program
+-o  set output path (follows the input file name)
+-s  enable short-circuit evaluation for all AND, OR operators
+-m<macro[=val]> define a macro named "macro" for conditional compilation
+-I<path> specify an additional directory to search for include files
+
+The original command line option -w to turn on warnings no longer has an effect, since warnings are now on by default
+
+===================================
+=== Additional supported syntax ===
+===================================
+
+Syntax which requires sfall for compiled scripts to be interpreted, is marked by asterix (*).
+
+> Optional arguments in user-defined procedures. You can only use constants for default values. It basically puts those constants in place of omitted arguments.
+
+new:
+    procedure test(variable x, variable y := 0, variable z := -1) begin
+    ...
+    end
+    ...
+    call test("value");
+
+old:
+    procedure test(variable x, variable y, variable z) begin
+    ...
+    end
+    ...
+    call test("value", 0, -1);
+
+
+> New logical operators "AndAlso", "OrElse" for short-circuit evaluation of logical expressions.
+Using these operators allow the right part of logical expressions not to be evaluated (executed, computed) if the result is already known. This can improve the performance of running scripts.
+
+Example:
+    if (obj andAlso obj_pid(obj) == PID_STIMPAK) then ...
+
+if obj is null, the second condition will not be checked and your script won't fail with "obj is null" error in debug.log
+
+This also has an effect that a value of last computed argument is returned as a result of whole expressions, instead of always 0 (false) or 1 (true):
+    obj := false;
+    display_msg(obj orElse "something");  // will print "something"
+
+You can also use the -s option to enable short-circuit evaluation for all the AND, OR operators in the script.
+NOTE: Be aware that it may break some old scripts because operators behavior is changed slightly.
+
+
+> Conditional expressions (Python-inspired), also known as ternary operator:
+
+new:
+    X := value1 if condition else value2
+
+old:
+    if (condition) then
+        X := value1;
+    else
+        X := value2;
+
+
+> To assign values, you can use the alternative assignment operator from C/Java instead of Pascal syntax.
+
+new:
+  x = 5;
+old:
+  x := 5;
+
+
+> Multiple variable decleration: Multiple variables can be declared on one line, seperated by commas. This is an alterative to the ugly begin/end block, or the bulky single variable per line style.
+
+new:
+  variable a, b, c;
+old:
+  variable begin a; b; c; end
+
+
+> Variable initialization with expressions: You can now initialize local variables with complex expressions instead of constants.
+
+new:
+  variable tile := tile_num(dude_obj);
+
+old:
+  variable tile;
+  tile := tile_num(dude_obj);
+
+NOTE: if your expression starts with a constant (eg. 2+2), enclose it in parentheses, otherwise compiler will be confused and give you errors.
+
+
+> Hexadecimal numerical constants: Simply prefix a number with 0x to create a hexadecimal. The numbers 0 to 9 and a-f are allowed in the number. The number may not have a decimal point.
+
+new:
+  a := 0x1000;
+old:
+  a := 4096;
+
+
+> increment/decrement operators: ++ and -- can be used as shorthand for +=1 and -=1 respectively. They are mearly a syntactic shorthand to improve readability, and so their use is only allowed where +=1 would normally be allowed.
+
+new:
+  a++;
+old:
+  a += 1;
+
+
+> "break" & "continue" statements: they work just like in most high-level languages. "break" jumps out of the loop. "continue" jumps right to the beginning of the next iteration (see "for" and "foreach" sections for additional details).
+
+new:
+  while (i < N) begin
+    // ...
+    if (/* some condition */) then break;
+    // ...
+  end
+
+old:
+  while (i < N and not(breakFlag)) begin
+    // ...
+    if (/* condition */) then breakFlag := true;
+    // ...
+  end
+
+new:
+  for (i := 0; i < N; i++) begin
+    // ...
+    if (/* condition */) then begin
+      // action
+      continue;
+    end
+    // else actions
+  end
+
+old:
+  for (i := 0; i < N; i++) begin
+    // ...
+    if (/* condition */) then begin
+      // action
+    end else begin
+      // else actions
+    end
+  end
+
+
+> "for" loops: Another piece of syntactic shorthand, to shorten while loops in many cases. Parentheses around the loop statements are recommended but not required (when not using parentheses, a semicolon is required after the 3rd loop statement).
+new:
+  for (i := 0; i < 5; i++) begin
+    display_msg("i = "+i);
+  end
+old
+  i := 0;
+  while (i < 5) do begin
+    display_msg("i = "+i);
+    i++;
+  end
+
+NOTE: "continue" statement in a "for" loop will recognize increment statement (third statement in parentheses) and will execute it before jumping back to the beginning of loop. This way you will not get an endless loop.
+
+
+> switch statements: A shorthand way of writing big 'if then else if...' blocks
+new:
+  switch get_attack_type begin
+  case ATKTYPE_PUNCH: display_msg("punch");
+  case ATKTYPE_KICK: display_msg("kick");
+  default: display_msg("something else");
+  end
+old:
+  variable tmp;
+  tmp := get_attack_type;
+  if tmp == ATKTYPE_PUNCH then begin
+    display_msg("punch");
+  end else if tmp == ATKTYPE_KICK then begin
+    display_msg("kick");
+  end else begin
+    display_msg("something else");
+  end
+
+
+> empty statements in blocks are allowed: This is just a convenience to save scripters a bit of memory. Some of the macros in the fallout headers include their own semicolons while others do not. With the original compiler you had to remember which was which, and if you got it wrong the script would not compile. Now it's always safe to include your own semicolon, even if the macro already had its own. For example, this would not compile with the original sslc, but will with the sfall edition:
+
+#define my_macro diplay_msg("foo");
+
+procedure start begin
+  my_macro;
+end
+
+
+> Procedure stringify operator "@": designed to make callback-procedures a better option and allow for basic functional programming. Basically it replaces procedure names preceeded by "@" by a string constant.
+Not many people know that since vanilla Fallout you can call procedures by "calling a variable" containing it's name as a string value. There was a couple of problems using this:
+- optimizer wasn't aware that you are referencing a procedure, and could remove it, if you don't call it explicitly (can be solved by adding making procedure "critical")
+- you couldn't see all references of a procedure from a Script Editor
+- it was completely not obvious that you could do such a thing, it was a confusing syntax
+
+old:
+    callbackVar := "Node000";
+    callbackVar();
+
+new:
+    callbackVar := @Node000;
+    callbackVar();
+
+
+
+> *arrays: In vanilla fallout arrays had to be constructed by reserving a block of global/map variables. Since sfall 2.7, specific array targeted functions have been available, but they are fairly messy and long winded to use. The compiler provides additional syntactic shorthand for accessing and setting array variables, as well as for array creation. When declaring an array variable, put a constant integer in []'s to give the number of elements in the array. (before sfall 3.4 you had to specify size in bytes for array elements, now it's not required, see "arrays.txt" for more information)
+
+new:
+  procedure bingle begin
+    variable a[2];
+    a[0] := 5;
+    a[a[0] - 4] := a[0] + 4;
+    display_msg("a[0]=" + a[0] + ", a[1]=" + a[1]);
+  end
+old:
+  procedure bingle begin
+    variable a;
+    a := temp_array(2, 4);
+    set_array(a, 0, 5);
+    set_array(a, get_array(a, 0) - 4, get_array(a, 0) + 4);
+    display_msg("a[0]=" + get_array(a, 0) + ", a[1]=" + get_array(a, 1));
+  end
+
+
+> *array expressions: sometimes you need to construct an array of elements and you will probably want to do it in just one expression. This is now possible:
+new:
+  list := ["A", "B", "C", "D"];
+
+old:
+  list := temp_array(4, 2);
+  list[0] := "A";
+  list[1] := "B";
+  list[2] := "C";
+  list[3] := "D";
+
+
+Syntax specific for associative arrays is also available. (see "arrays.txt" for full introduction to this type of arrays).
+
+> *map array expressions:
+
+  map := {5: "five", 10: "ten", 15: "fifteen", 20: "twelve"};
+
+
+> * "dot" syntax to access elements of associative arrays. "dot" syntax allows to work with arrays like objects:
+  trap.radius := 3;
+  trap.tile := tile_num(dude_obj);
+
+you can chain dot and bracket syntax to access elements of multi-dimensional arrays:
+  collectionList[5].objectList[5].name += " foo";
+
+NOTE: when using incremental operators like +=, *=, ++, -- compiler will use additional temp variable to get an array at penultimate level in order to avoid making the same chain of "get_array" calls twice.
+
+
+> * "foreach" loops: A shorthand method of looping over all elements in an array. Syntax is 'foreach (<symbol> in <expression>) '
+new:
+  procedure bingle begin
+    variable critter;
+    foreach (critter in list_as_array(LIST_CRITTERS)) begin
+      display_msg(""+critter);
+    end
+  end
+old:
+  procedure bingle begin
+    variable begin critter; array; len; count; end
+    array := list_as_array(LIST_CRITTERS);
+    len := len_array(array);
+    count := 0;
+    while count < len do begin
+      critter := array[count];
+      display_msg("" + critter);
+    end
+  end
+
+If you want an index array element (or key for "maps") at each iteration, use syntax: 'foreach (<symbol>: <symbol> in <expression>) '
+  foreach (pid: price in itemPriceMap) begin
+    if (itemPid == pid) then
+      itemPrice := price;
+  end
+
+If you want to add additional condition for continuing the loop, use syntax: 'foreach (<symbol> in <expression> while <expression>) '. In this case loop will iterate over elements of an array until last element or until "while" expression is true (whatever comes first).
+
+NOTE: just like "for" loop, "continue" statement will respect increments of a hidden counter variable, so you can safely use it inside "foreach".
+
+
+
+
+====================
+=== int2ssl note ===
+====================
+
+int2ssl by Anchorite (TeamX) is included in sfall modderspack package. It was updated to support all additional opcodes of sfall, along with some syntax features. You can use it to decompile any sfall or non-sfall script.
+
+=============
+=== Fixes ===
+=============
+
+playmoviealpharect was using the token for playmoviealpha, breaking both functions in the process.
+
+addbuttonflag had an entry in the token table, and could be parsed, but was missing an entry in the emit list. This resulted in the compiler accepting it as a valid function, but not outputting any code for it into the compiled script.
+
+The function tokenize was missing an entry in the token table, and so would not be recognised by the compiler.
+
+fixed the check for the 'call "foo"' syntax so that non-string constants will no longer be accepted.
+
+==============================
+=== Backward compatibility ===
+==============================
+
+There are several changes in this version of sslc which may result in problems for previously working scripts. A new command line option '-b' is available, which will turn off all new fixes and features which have the possibility of causing a previously compiling script to change its behaviour. (And only those features; anything which would not compile under the old sslc is not affected.) This includes the following:
+
+- Since 'for', 'foreach', 'break', 'continue', 'in' and 'tokenize' are now hardcoded names, existing scripts that use any of them as a variable or procedure name will no longer compile.
+
+- Missing a semicolon after a variable declaration is now a hard error. (Originally sslc would check for the semicolon, but would not complain if it was missing.)
+
+- The function addbuttonflag used to be recognised by the compiler, but would not emit any code into the int file.
+
+- The function playmoviealpharect compiled as playmoviealpha
+
+
+=================
+=== Changelog ===
+=================
+
+> sfall 4.2.3
+- fixed compiler giving "assignment operator expected" error when a variable-like macro is not being defined properly
+- added new logical operators "AndAlso", "OrElse" for short-circuit evaluation of logical expressions
+- added an alternative (C/Java-style) assignment operator "="
+- added support for new "div" operator (unsigned integer division)
+
+> sfall 4.2.2
+- added support for new opcode "reg_anim_callback"
+
+> sfall 4.2.1
+- the basic optimization is now enabled by default when not specifying any optimization options
+- added -m<macro[=val]> option to define a macro named "macro" for conditional compilation
+- added -I<path> option to specify an additional directory to search for include files
+- unreferenced "critical" procedures and procedures with the names "Node998" and "Node999" are now removed by the optimizer
+
+> sfall 4.2
+- now it is possible to run preprocess or optimization passes in backward compatibility mode
+- added support for new opcode "register_hook_proc_spec"
+
+> sfall 4.0:
+- enabled code for "ceil" math function
+- fixed missing argument for "how_much" function
+- added "desc_p_proc" (from Fallout 1) to protected procedures that should not be removed by the optimizer
+- fixed compiler giving "division by zero" error when using zero as the second factor in multiplication
+
+> sfall 3.8
+- added support for new universal opcodes sfall_funcX
+
+> sfall 3.6:
+- added Python-style ternary operator (conditional expression)
+- added -s short-circuit evalution option for AND, OR expressions
+- int2ssl will detect and decompile conditional expressions and short-circuit logical operators
+- added -F option to include full file paths in "#line" directives after preprocessing
+- added -D option to write abstract syntax tree into .txt file
+- fixed compiler crash when number of arguments in procedure declaration does not match definition
+- fixed incorrect constant folding of "bwnot" operator
+- fixed more invalid results in constant folding
+- implemented optional arguments for user-defined procedures
+- implemented stringify procedure names using @ operator, which is helpful to pass procedures around to call them from variables (it will properly handle references)
+- logic for procedures passed as arguments to scripting functions was moved from code generation to parsing stage
+- now it is possible to call user-defined procedures inside argument list of scripting functions, without compiler attempting to treat them as procedure references and probably fail (procedures will still be passed, but only to appropriate scripting functions at appropriate argument positions)
+- int2ssl will now place empty parantheses after a call to user-defined procedure - this will distinct calls from passing procedures to some scripting functions (like giq_option)
+- fixed inline procedure "calls" not working when optimization is enabled
+- added column numbers to error/warning output
+- added code to simplify adding sfall opcodes into compiler (need to add code in 3 places, instead of 7 places for each opcode)
+- fixed bug when initializing variable with expression starting from a symbol
+- added division by zero constant check
+
+> sfall 3.5:
+- completed namespace compression optimization with respect to imported/exported variables
+- changed 'for' and 'foreach' syntax to allow parentheses which are easier to read IMHO
+- heavy code refactoring - split "parse.c" into several files, replaced all dirty workaround code in "lex()" (some syntax features) with parser-level equivalents
+- added syntax to reference elements in multi-dimensional arrays (unlimited sequence of brackets [] and dots . )
+- added fully featured "break" and "continue" statements for loops
+- moved some optimizations (namely constant propagation and variable reuse) to "experimental" because they were breaking my scripts
+- added ability to initialize variables with expressions
+
+> sfall 3.4:
+- added "foreach .. while .." syntax
+- added array expressions for lists and maps
+- added "foreach (key: value in ...)" syntax for convenience
+- fixed crash bug in "for" loop parsing function
+- added ability to access array elements with string keys using OOP-like dot (".") syntax

artifacts/scripting/headers/define_extra.h

@@ -2,6 +2,16 @@
 #ifndef DEFINE_EXTRA_H
 #define DEFINE_EXTRA_H
 
+#define BODY_HIT_HEAD       (0)
+#define BODY_HIT_LEFT_ARM   (1)
+#define BODY_HIT_RIGHT_ARM  (2)
+#define BODY_HIT_TORSO      (3)
+#define BODY_HIT_RIGHT_LEG  (4)
+#define BODY_HIT_LEFT_LEG   (5)
+#define BODY_HIT_EYES       (6)
+#define BODY_HIT_GROIN      (7)
+#define BODY_UNCALLED       (8)
+
 #define OBJ_TYPE_ITEM       (0)
 #define OBJ_TYPE_CRITTER    (1)
 #define OBJ_TYPE_SCENERY    (2)
@@ -31,6 +41,7 @@
 
 #define WEAPON_BIGGUN         256  // 0x00000100 - Big Gun
 #define WEAPON_2HAND          512  // 0x00000200 - 2Hnd (weapon is two-handed)
+#define WEAPON_ENERGY        1024  // 0x00000400 - Energy Weapon (forces weapon to use Energy Weapons skill)
 
 #define ATKMODE_PRI_NONE        0
 #define ATKMODE_PRI_PUNCH       1  // 0001
@@ -76,19 +87,34 @@
 #define FLAG_SEEN         (0x40000000)
 #define FLAG_SHOOTTHRU    (0x80000000)
 
-
-/* Critter Flags */
+/* Critter flags */
 #define CFLG_BARTER             2  // 0x00000002 - Barter (can trade with)
-#define CFLG_NOSTEAL           32  // 0x00000020 - Steal (cannot steal from)
+#define CFLG_NOSTEAL           32  // 0x00000020 - Steal (cannot be stolen from)
 #define CFLG_NODROP            64  // 0x00000040 - Drop (doesn't drop items)
 #define CFLG_NOLIMBS          128  // 0x00000080 - Limbs (cannot lose limbs)
 #define CFLG_NOAGES           256  // 0x00000100 - Ages (dead body does not disappear)
-#define CFLG_NOHEAL           512  // 0x00000200 - Heal (damage is not cured with time)
+#define CFLG_NOHEAL           512  // 0x00000200 - Heal (damage is not healed with time)
 #define CFLG_INVULN          1024  // 0x00000400 - Invulnerable (cannot be hurt)
 #define CFLG_FLATTN          2048  // 0x00000800 - Flatten (leaves no dead body)
-#define CFLG_SPECIAL         4096  // 0x00001000 - Special (there is a special type of death)
-#define CFLG_RANGED          8192  // 0x00002000 - Range (melee attack is possible at a distance)
-#define CFLG_NOKNOCKDOWN    16384  // 0x00004000 - Knock (cannot be knocked down)
+#define CFLG_SPECIAL         4096  // 0x00001000 - Special (has a special type of death)
+#define CFLG_RANGED          8192  // 0x00002000 - Range (has extra hand-to-hand range)
+#define CFLG_NOKNOCKBACK    16384  // 0x00004000 - Knock (cannot be knocked back)
+#define CFLG_NOKNOCKDOWN    CFLG_NOKNOCKBACK  // obsolete
+
+/* Window flags */
+#define WIN_FLAG_MOVEONTOP          (0x4)
+#define WIN_FLAG_HIDDEN             (0x8)
+#define WIN_FLAG_EXCLUSIVE         (0x10)
+#define WIN_FLAG_TRANSPARENT       (0x20)
+
+/* Message window flags */
+#define MSGBOX_AUTOSIZE             (0x0)
+#define MSGBOX_NORMAL               (0x1)
+#define MSGBOX_SMALL                (0x2)
+#define MSGBOX_ALIGN_LEFT           (0x4) // text aligned to left
+#define MSGBOX_ALIGN_TOP            (0x8) // text aligned to top
+#define MSGBOX_YESNO               (0x10) // use YES/NO buttons instead of DONE
+#define MSGBOX_CLEAN               (0x20) // no buttons
 
 //remove inven obj defines
 #define RMOBJ_CONSUME_DRUG        4666772
@@ -109,7 +135,7 @@
 #define RMOBJ_RM_MULT_OBJS        4563866
 #define RMOBJ_REPLACE_WEAPON      4658526
 #define RMOBJ_THROW               4266040
-#define RMOBJ_SUB_CONTAINER       4683191  // search and remove the item from a container inside of an inventory
+#define RMOBJ_SUB_CONTAINER       4683191  // search and remove the item from nested containers in the inventory
 
 // common prototype offsets for get/set_proto_data
 #define PROTO_PID             (1)
@@ -300,14 +326,15 @@
 #define OBJ_DATA_FID                (0x20)
 #define OBJ_DATA_ELEVATION          (0x28)
 #define OBJ_DATA_PID                (0x64)
-#define OBJ_DATA_CID                (0x68) // combat id, used for savegame
-#define OBJ_DATA_SID                (0x78)
+#define OBJ_DATA_CID                (0x68) // combat ID, used for savegame
+#define OBJ_DATA_SID                (0x78) // script ID
+#define OBJ_DATA_SCRIPT_INDEX       (0x80) // script index number in scripts.lst
 // items
-#define OBJ_DATA_CUR_CHARGES        (0x3C)
+#define OBJ_DATA_CUR_CHARGES        (0x3C) // for key items it's the key code
 // critters
 #define OBJ_DATA_COMBAT_STATE       (0x3C) // flags: 1 - combat, 2 - target is out of range, 4 - flee
 #define OBJ_DATA_CUR_ACTION_POINT   (0x40)
 #define OBJ_DATA_DAMAGE_LAST_TURN   (0x48)
-#define OBJ_DATA_WHO_HIT_ME         (0x54)
+#define OBJ_DATA_WHO_HIT_ME         (0x54) // current target of the critter
 
 #endif // DEFINE_EXTRA_H

artifacts/scripting/headers/lib.math.h

@@ -5,6 +5,17 @@
   Numbers...
 */
 
+#define above(a, b)        (unsigned_comp(a, b) > 0)
+#define above_equal(a, b)  (unsigned_comp(a, b) >= 0)
+#define below(a, b)        (unsigned_comp(a, b) < 0)
+#define below_equal(a, b)  (unsigned_comp(a, b) <= 0)
+
+// for sfall 4.2.3/3.8.23
+pure procedure unsigned_comp(variable a, variable b) begin
+   if ((a bwxor b) == 0) then return 0; // a == b
+   return 1 if ((b == 0) orElse a div b) else -1;
+end
+
 #define MAX(x, y)    ((x > y) * x + (x <= y) * y)
 #define MIN(x, y)    ((x < y) * x + (x >= y) * y)
 #define in_range(x, from, to)    (x >= from and x <= to)