Forgot to commit main.cpp in 1209b7e

Updated Russian and Germen translations.

artifacts/config_files/Translations.ini

@@ -4,7 +4,7 @@ KarmaGain=You gained %d karma.
 KarmaLoss=You lost %d karma.
 HighlightFail1=You aren't carrying a motion sensor.
 HighlightFail2=Your motion sensor is out of charge.
-SuperStimExploitMsg=You cannot use a super stim on someone who is not injured!
+SuperStimExploitMsg=You cannot use this item on someone who is not injured!
 BlockedCombat=You cannot enter combat at this time.
 SaveSfallDataFail=ERROR saving extended savegame information! Check if other programs interfere with savegame files/folders and try again.
 PartyLvlMsg=Lvl:
@@ -16,3 +16,20 @@ NPCPickupFail=%s cannot pick up the item.
 RaceText=Race
 StyleText=Style
 DoneBtn=Done
+
+;Custom names for player's unarmed attacks (max 16 characters)
+[Unarmed]
+;Punch=Punch:
+;Kick=Kick:
+;StrongPunch=Strong Punch:
+;HammerPunch=Hammer Punch:
+;Haymaker=Haymaker:
+;Jab=Jab:
+;PalmStrike=Palm Strike:
+;PiercingStrike=Piercing Strike:
+;StrongKick=Strong Kick:
+;SnapKick=Snap Kick:
+;PowerKick=Power Kick:
+;HipKick=Hip Kick:
+;HookKick=Hook Kick:
+;PiercingKick=Piercing kick:

artifacts/config_files/Tweaks.ini

@@ -0,0 +1,13 @@
+;Game engine tweaks
+
+[Main]
+
+
+[Items]
+;Override the PIDs of the standard healing drugs that AI will use in combat
+;Set to -1 if you don't want AI to identify this item as a healing drug
+;Note: Starting from sfall 4.3.1/3.8.31, you can set a new flag (FlagsExt: 0x04000000)
+;in the proto for other items, so AI will use them for healing in combat as well
+STIMPAK=40
+SUPER_STIMPAK=144
+HEALING_POWDER=237

artifacts/config_files/Unarmed.ini

@@ -0,0 +1,66 @@
+; This file lets you configure the requirements and effects of unarmed attacks
+
+; You can leave the value empty or omit the parameter to use the engine default value
+
+; Strong Punch
+[8]
+ReqLevel=1    ; required player level
+SkillLevel=55 ; required Unarmed skill level
+
+; Required stats
+Stat0=0 ; ST
+Stat1=0 ; PE
+Stat2=0 ; EN
+Stat3=0 ; CH
+Stat4=0 ; IN
+Stat5=6 ; AG
+Stat6=0 ; LK
+
+MinDamage=1
+MaxDamage=2
+BonusDamage=3 ; bonus damage added to the minimum and maximum damage
+BonusCrit=0   ; value of the critical hit chance
+APCost=
+
+Penetrate=0 ; set to 1 to make the attack reduce target's armor DT (the formula is determined by the engine or a hook script)
+Secondary=0 ; set to 1 to assign the attack to the secondary mode (be careful when setting this parameter)
+
+; Hammer Punch
+[9]
+
+; Haymaker
+[10]
+
+; Jab
+[11]
+
+; Palm Strike
+[12]
+
+; Piercing Strike
+[13]
+
+; Strong Kick
+[14]
+
+; Snap Kick
+[15]
+
+; Power Kick
+[16]
+
+; Hip Kick
+[17]
+
+; Hook Kick
+[18]
+
+; Piercing Kick
+[19]
+
+; Default attacks (any requirements are ignored)
+; Punch
+[4]
+
+; Kick
+[5]

artifacts/ddraw.ini

@@ -1,5 +1,5 @@
 ;sfall configuration settings
-;v3.8.30
+;v3.8.31
 
 [Main]
 ;Change to 1 if you want to use command line args to tell sfall to use another ini file.
@@ -29,9 +29,6 @@ SpeedMulti9=900
 ;The initial speed at game startup
 SpeedMultiInitial=100
 
-;Set to 1 to also affect the playback speed of MVE video files without an audio track
-AffectPlayback=0
-
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Graphics]
 ;Set to 0 for 8 bit fullscreen
@@ -49,8 +46,8 @@ GraphicsWidth=0
 GraphicsHeight=0
 
 ;Window position data. Do not modify
-;Set to 0 to reset if the window position is incorrect
-WindowData=0
+;Set to -1 or 0 to reset if the window position is incorrect
+WindowData=-1
 
 ;Uncomment the option to use a hardware shader (requires DX9 graphics mode)
 ;The shader file <name>.fx must be placed in <GameRoot>\<master_patches>\shaders\ and must contain one technique with one or more passes
@@ -104,6 +101,9 @@ WorldMapTerrainInfo=0
 ;Set to 0 to leave the default unchanged (i.e. 4). The maximum is 32
 NumSoundBuffers=0
 
+;Set to 1 to enable fade effects for background music when stopping and starting the playback
+FadeBackgroundMusic=1
+
 ;Set to 1 to allow attaching sound files to combat float messages
 AllowSoundForFloats=0
 
@@ -116,6 +116,11 @@ AllowDShowSound=0
 ;Set to 2 to overwrite all occurrences of the music path
 OverrideMusicDir=1
 
+;Set to 1 to automatically search for new SFX sound files at game startup
+;Note: With this option enabled, you will no longer need to use the utility regsnd.exe to register new SFX sounds
+;This will slightly increase the startup time of the game on older computers
+AutoSearchSFX=1
+
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Input]
 ;Set to 1 to enable the mouse scroll wheel to scroll through the inventory, barter, and loot screens
@@ -220,7 +225,7 @@ DebugEditorKey=0
 Fallout1Behavior=0
 
 ;Time limit in years. Must be between -3 and 13
-;Set to 0 if you want to die the instant you leave arroyo
+;Set to 0 if you want to die the instant you leave Arroyo
 ;Set to -1 to remove the time limit, and automatically reset the date back to 2241 each time you would have reached it
 ;Set to -2 or -3 to remove the time limit, automatically reset the date, but override Fallout's GetDate function to return the correct year
 TimeLimit=13
@@ -257,7 +262,7 @@ WorldMapSlots=0
 ;To use a config file other than fallout2.cfg, uncomment the next line and add the name of your new file
 ;ConfigFile=
 
-;Set to 1 to enable functions relating to overriding the file system
+;Set to 1 to enable script functions relating to overriding the file system
 UseFileSystemOverride=0
 
 ;To use a patch file other than patch000.dat, uncomment the next line and add your new file name
@@ -436,7 +441,7 @@ NPCsTryToSpendExtraAP=0
 ;Note that enabling this option can affect the weapon of choice for some NPCs
 AIBestWeaponFix=1
 
-;Set to 1 to fix NPCs not taking chem_primary_desire in AI.txt as drug use preference when using drugs in their inventory
+;Set to 1 to fix NPCs not taking chem_primary_desire in AI.txt as a preference list when using drugs in their inventory
 ;Set to 2 to allow NPCs to use only the drugs listed in chem_primary_desire and healing drugs (stimpaks and healing powder)
 ;Note: chem_primary_desire w/o fixes prevents the specified item PID from being consumed if all three values in the list are the same PID
 ;chem_primary_desire also works as a priority list of drug items the NPC will try to pick up in combat when they are on the ground
@@ -489,12 +494,13 @@ UseScrollingQuestsList=1
 ExtraSaveSlots=0
 
 ;To use more than one save slot for quick saving (F6 key) without picking a slot beforehand, set the next two lines
-;AutoQuickSave sets how many save slots on a page you want to use for quick saving (valid range: 1..10)
-;AutoQuickSavePage is the page number to use (valid range: 1..1000) if ExtraSaveSlots is enabled
-;The quick saves will be rotated from the first slot on the page to the n-th slot
-;Set to 0 to disable. AutoQuickSave will use the current selected page if AutoQuickSavePage is disabled
+;Quick save will cyclically overwrite saves from the first slot on the specified page to the last slot on the n-th page
+;AutoQuickSave sets how many pages you want to use for quick saving (valid range: 1..10)
+;Set to 0 to disable
 AutoQuickSave=0
-AutoQuickSavePage=0
+;AutoQuickSavePage is the page number to start at if ExtraSaveSlots is enabled (valid range: 0..999)
+;Set to -1 to use the current selected page (not recommended)
+AutoQuickSavePage=1
 
 ;Set to 1 to speed up the HP/AC counter animations
 ;Set to 2 to update the HP/AC counters instantly
@@ -644,7 +650,7 @@ ExplosionsEmitLight=0
 
 ;Set to 1 to enable the new arrays behavior (default behavior)
 ;Set to 0 for backward compatibility with pre-3.4 scripts
-arraysBehavior=1
+ArraysBehavior=1
 
 ;Set to 1 to add proper checks to see if there is enough ammo to attack with weapons that use multiple ammo per shot
 CheckWeaponAmmoCost=0
@@ -773,7 +779,8 @@ CreditsAtBottom=0
 ;Point the next line to an ini file containing the replacement skill data
 ;SkillsFile=sfall\Skills.ini
 
-;To add additional perks to the game, uncomment the next line and set it to point to a file containing perk information
+;To add additional perks to the game, uncomment the next line and point to a file containing perk information
+;See the Perks.ini in the modders pack for an example file
 ;PerksFile=sfall\Perks.ini
 
 ;To add additional books to the game, uncomment the next line and point to a file containing book information
@@ -783,6 +790,13 @@ CreditsAtBottom=0
 ;Point to an ini file containing elevator data
 ;ElevatorsFile=sfall\Elevators.ini
 
+;Allows you to change the requirements and effects of unarmed attacks
+;See the Unarmed.ini in the modders pack for an example file
+;UnarmedFile=sfall\Unarmed.ini
+
+;To change some engine parameters for the game mechanics, uncomment the next line
+;TweaksFile=sfall\Tweaks.ini
+
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Debugging]
 ;Extra sfall configuration settings that can be used by modders

artifacts/example_mods/NPCArmor_Lite/gl_npcarmor_lite.ssl

@@ -11,7 +11,7 @@
 
    Requires sfall 3.8.29 or higher
 
-   version 1.1
+   version 1.4
 
 */
 
@@ -79,13 +79,13 @@ procedure check_weapon_change(variable critter, variable weapon, variable isWiel
 end
 
 /*
-   Finds the first weapon which can be used by the party member in the inventory
+   Finds the first weapon that can be used by the party member in the inventory
 */
 procedure search_alt_weapon(variable critter) begin
    variable obj, res, i := 0;
    obj := inven_ptr(critter, 0);
    while (obj) do begin
-      if (obj_item_subtype(obj) == item_type_weapon) then begin
+      if (obj_item_subtype(obj) == item_type_weapon and weapon_is_unusable(obj) == false) then begin
          if (unWieldWeapon == 0 or unWieldWeapon != obj_pid(obj)) then begin
             res := check_weapon_change(critter, obj, 1);
             if (res == -1) then begin

artifacts/scripting/compiler/optimization.md

@@ -0,0 +1,110 @@
+Optimization
+------------
+
+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 (True) 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.md

@@ -0,0 +1,431 @@
+SSLC
+----
+
+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 `#include` files 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/site_arc/utils/index.html](http://www.teamx.ru/site_arc/utils/index.html)
+
+### Command line options
+
+```
+-q  don't wait for input on error
+-n  no warnings
+-b  backward compatibility mode
+-l  no logo
+-p  preprocess source
+-P  preprocess only (don't generate .int)
+-F  write full file paths in "#line" directives
+-O  optimize code (full by default, see optimization.md)
+-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 asterisk (*).
+
+- 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 `false` (0) or `true` (1):
+  ```
+  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 declaration: 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
+  ```
+  __NOTE:__ **Does not work currently.**
+
+- 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.
+  - old:
+    ```
+    callbackVar := "Node000";
+    callbackVar();
+    ```
+  - new:
+    ```
+    callbackVar := @Node000;
+    callbackVar();
+    ```
+  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
+
+- (*) **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 `[]`` 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.md** 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.md** for full introduction to this type of arrays).
+
+- (*) **Map array expressions**:
+  ```
+  map := {5: "five", 10: "ten", 15: "fifteen", 20: "twelve"};
+  ```
+
+- (*) The dot `.` syntax to access elements of associative arrays and allow 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`.
+
+---
+
+### 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`.
+
+### 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.
+
+---
+
+### Changelog
+
+**sfall 4.2.9:**
+- added support for additional universal opcodes `sfall_func7` and `sfall_func8`
+- fixed a compilation error when the script has a UTF-8 BOM
+
+**sfall 4.2.7:**
+- added ability to declare local variables anywhere in the procedure body
+
+**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

@@ -120,26 +120,29 @@
 #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
-#define RMOBJ_CONTAINER           4683293  // same as RMOBJ_TRADE
-#define RMOBJ_USE_OBJ             4666865
-#define RMOBJ_EQUIP_ARMOR         4658121
-#define RMOBJ_EQUIP_WEAPON        4658675
-#define RMOBJ_UNLOAD_WEAPON       4667030
-//#define RMOBJ_LOAD_WEAPON       4831349  // same as RMOBJ_DROP
-#define RMOBJ_USE_DRUG_ON         4834866
-#define RMOBJ_STEAL_VIEW          4668206
-//#define RMOBJ_DROP_DYNAMITE     4666865  // same as USE_OBJ
-#define RMOBJ_ITEM_DESTROYED      4543215
-#define RMOBJ_ITEM_REMOVED        4548572
-#define RMOBJ_ARMOR_EQUIPED       4651961
-#define RMOBJ_LEFT_HAND_EQUIPED   4651899
-#define RMOBJ_RIGHT_HAND_EQUIPED  4651934
-#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 nested containers in the inventory
+//remove inven obj defines for the 4th argument to hs_removeinvobj
+#define RMOBJ_CONSUME_DRUG        4666772  // (inven_action_cursor_)
+#define RMOBJ_CONTAINER           4683293  // same as RMOBJ_TRADE (item_move_func_)
+#define RMOBJ_USE_OBJ             4666865  // (inven_action_cursor_)
+#define RMOBJ_EQUIP_ARMOR         4658121  // (inven_pickup_)
+#define RMOBJ_EQUIP_WEAPON        4658675  // (switch_hand_)
+#define RMOBJ_UNLOAD_WEAPON       4667030  // (inven_action_cursor_)
+//#define RMOBJ_LOAD_WEAPON       4831349  // same as RMOBJ_DROP (obj_remove_from_inven_)
+#define RMOBJ_USE_DRUG_ON         4834866  // (obj_use_item_on_)
+#define RMOBJ_STEAL_VIEW          4668206  // (loot_container_)
+//#define RMOBJ_DROP_DYNAMITE     4666865  // same as RMOBJ_USE_OBJ
+#define RMOBJ_ITEM_DESTROYED      4543215  // (op_destroy_object_)
+#define RMOBJ_ITEM_REMOVED        4548572  // (op_rm_obj_from_inven_)
+#define RMOBJ_ARMOR_EQUIPED       4651961  // (setup_inventory_)
+#define RMOBJ_LEFT_HAND_EQUIPED   4651899  // (setup_inventory_)
+#define RMOBJ_RIGHT_HAND_EQUIPED  4651934  // (setup_inventory_)
+#define RMOBJ_RM_MULT_OBJS        4563866  // (op_rm_mult_objs_from_inven_)
+#define RMOBJ_REPLACE_WEAPON      4658526  // (switch_hand_)
+#define RMOBJ_THROW               4266040  // (action_ranged_)
+#define RMOBJ_SUB_CONTAINER       4683191  // search and remove the item from nested containers in the inventory (item_remove_mult_)
+#define RMOBJ_AI_USE_DRUG_ON      4359920  // remove before AI uses the drug in combat (ai_check_drugs_)
+//#define RMOBJ_AI_USE_DRUG_ON_1  4359639  // same as RMOBJ_AI_USE_DRUG_ON (obsolete, use only for sfall before 4.3.1/3.8.31)
+//#define RMOBJ_AI_USE_DRUG_ON_2  4360176  // same as RMOBJ_AI_USE_DRUG_ON (obsolete, use only for sfall before 4.3.1/3.8.31)
 
 // common prototype offsets for get/set_proto_data
 #define PROTO_PID             (1)
@@ -330,9 +333,11 @@
 #define OBJ_DATA_CUR_FRM            (0x18) // current frame number
 #define OBJ_DATA_ROTATION           (0x1C)
 #define OBJ_DATA_FID                (0x20)
+//#define OBJ_DATA_FLAGS            (0x24) // the same flags set in prototypes (PROTO_FLAG)
 #define OBJ_DATA_ELEVATION          (0x28)
+#define OBJ_DATA_MISC_FLAGS         (0x38)
 #define OBJ_DATA_PID                (0x64)
-#define OBJ_DATA_CID                (0x68) // combat ID, used for savegame
+#define OBJ_DATA_CID                (0x68) // combat ID, used by critters in savegame (don't change while in combat)
 #define OBJ_DATA_SID                (0x78) // script ID
 #define OBJ_DATA_SCRIPT_INDEX       (0x80) // script index number in scripts.lst
 // items

artifacts/scripting/headers/sfall.h

@@ -1,7 +1,7 @@
 #ifndef SFALL_H
 #define SFALL_H
 
-//Recognised modes for set_shader_mode and get_game_mode
+// Recognised modes for set_shader_mode and get_game_mode
 #define WORLDMAP    (0x1)
 #define DIALOG      (0x4)
 #define ESCMENU     (0x8)
@@ -24,7 +24,7 @@
 #define COUNTERWIN  (0x100000) // counter window for moving multiple items or setting a timer
 #define SPECIAL     (0x80000000)
 
-//Valid arguments to register_hook
+// Valid arguments to register_hook
 #define HOOK_TOHIT            (0)
 #define HOOK_AFTERHITROLL     (1)
 #define HOOK_CALCAPCOST       (2)
@@ -54,7 +54,7 @@
 #define HOOK_ADJUSTFID        (26)
 #define HOOK_GAMEMODECHANGE   (31)
 
-//Valid arguments to list_begin
+// Valid arguments to list_begin
 #define LIST_CRITTERS    (0)
 #define LIST_GROUNDITEMS (1)
 #define LIST_SCENERY     (2)
@@ -64,7 +64,7 @@
 #define LIST_SPATIAL     (6)
 #define LIST_ALL         (9)
 
-//Valid window types for get_window_attribute
+// Valid window types for get_window_attribute
 #define WINTYPE_INVENTORY    (0) // any inventory window (player/loot/use/barter)
 #define WINTYPE_DIALOG       (1)
 #define WINTYPE_PIPBOY       (2)
@@ -75,14 +75,14 @@
 #define WINTYPE_ESCMENU      (7) // escape menu
 #define WINTYPE_AUTOMAP      (8)
 
-//Valid flags for force_encounter_with_flags
+// Valid flags for force_encounter_with_flags
 #define ENCOUNTER_FLAG_NO_CAR   (0x1)
 #define ENCOUNTER_FLAG_LOCK     (0x2)  // block new forced encounter by the next function call until the current specified encounter occurs
 #define ENCOUNTER_FLAG_NO_ICON  (0x4)  // disable displaying the flashing icon
 #define ENCOUNTER_FLAG_ICON_SP  (0x8)  // use special encounter icon
 #define ENCOUNTER_FLAG_FADEOUT  (0x10) // fade out the screen on encounter (Note: you yourself should restore the fade screen when entering the encounter)
 
-//The attack types returned by get_attack_type
+// The attack types returned by get_attack_type
 #define ATKTYPE_LWEP1           (0)
 #define ATKTYPE_LWEP2           (1)
 #define ATKTYPE_RWEP1           (2)
@@ -104,18 +104,18 @@
 #define ATKTYPE_HOOKKICK       (18)
 #define ATKTYPE_PIERCINGKICK   (19)
 
-//Some possible values for the 4th argument to hs_removeinvobj
-#define RMOBJ_DROP      (0x49B875)  //If the object is dropped manually by the player from the inventory screen
-#define RMOBJ_TRADE     (0x47761D)  //If the object is offered up as a trade
-#define RMOBJ_DROPMULTI (0x45C1CF)  //When dropping a part of a stack (RMOBJ_DROP occures first)
+// Some possible values for the 4th argument to hs_removeinvobj
+#define RMOBJ_DROP             (0x49B875)  // If the object is dropped manually by the player from the inventory screen
+#define RMOBJ_TRADE            (0x47761D)  // If the object is offered up as a trade
+#define RMOBJ_DROPMULTI        (0x45C1CF)  // When dropping a part of a stack (RMOBJ_DROP occurs first)
 
-//Return values for "typeof"
+// Return values for "typeof"
 #define VALTYPE_NONE  (0) // not used yet
 #define VALTYPE_INT   (1)
 #define VALTYPE_FLOAT (2)
 #define VALTYPE_STR   (3)
 
-//Arrays defines
+/* ARRAYS FUNCTION DEFINES */
 
 // create persistent list
 #define create_array_list(size)     (create_array(size, 0))
@@ -246,6 +246,9 @@
 #define ADD_PERK_MODE_PERK      (2)  // add to the player's perks list
 #define ADD_PERK_MODE_REMOVE    (4)  // remove from the list of selectable perks (after added to the player)
 
+
+/* MISC FUNCTION MACROS */
+
 // instantly apply the item to dude_obj (w/o animation)
 #define use_item_on_dude(item)                          set_self(dude_obj);             \
                                                         set_self(dude_obj);             \
@@ -257,17 +260,17 @@
                                                         if (get_flags(obj1) bwand FLAG_MULTIHEX) then distance--; \
                                                         if (get_flags(obj2) bwand FLAG_MULTIHEX) then distance--
 
-
-/* sfall metarule3 function macros */
-// sets the number of days (range 1...127) for the Frank Horrigan encounter, or disable the encounter if days is set to 0
-#define set_horrigan_days(day)                          metarule3(200, day, 0, 0)
-// clears the keyboard input buffer, use it in the HOOK_KEYPRESS hook to clear keyboard events before calling functions that are waiting for keyboard input
-#define clear_keyboard_buffer                           metarule3(201, 0, 0, 0)
-
 // checks if the specified PID number exists in the list of registered protos
 #define check_pid(pid)                                  (get_proto_data(pid, 0) != -1)
 
-/* sfall_funcX macros */
+// sets the status of an unusable weapon that cannot be used in combat
+#define set_weapon_unusable(item)                       set_object_data(item, OBJ_DATA_MISC_FLAGS, get_object_data(item, OBJ_DATA_MISC_FLAGS) bwor  0x00000010)
+#define set_weapon_usable(item)                         set_object_data(item, OBJ_DATA_MISC_FLAGS, get_object_data(item, OBJ_DATA_MISC_FLAGS) bwand 0xFFFFFFEF)
+#define weapon_is_unusable(item)                        (get_object_data(item, OBJ_DATA_MISC_FLAGS) bwand 0x00000010)
+
+
+/* SFALL_FUNCX MACROS */
+
 #define add_extra_msg_file(name)                                sfall_func1("add_extra_msg_file", name)
 #define add_global_timer_event(time, fixedParam)                sfall_func2("add_g_timer_event", time, fixedParam)
 #define add_iface_tag                                           sfall_func0("add_iface_tag")
@@ -307,6 +310,7 @@
 #define get_npc_stat_min(stat)                                  sfall_func2("get_stat_min", stat, 1)
 #define get_sfall_arg_at(argNum)                                sfall_func1("get_sfall_arg_at", argNum)
 #define get_text_width(text)                                    sfall_func1("get_text_width", text)
+#define hide_win                                                sfall_func0("hide_window")
 #define hide_window(winName)                                    sfall_func1("hide_window", winName)
 #define interface_art_draw(winID, artFile, x, y)                sfall_func4("interface_art_draw", winID, artFile, x, y)
 #define interface_art_draw_frame(winID, artID, x, y, frame)     sfall_func5("interface_art_draw", winID, artID, x, y, frame)
@@ -327,6 +331,7 @@
 #define message_box(text)                                       sfall_func1("message_box", text)
 #define metarule_exist(metaruleName)                            sfall_func1("metarule_exist", metaruleName)
 #define npc_engine_level_up(toggle)                             sfall_func1("npc_engine_level_up", toggle)
+#define obj_is_openable(obj)                                    sfall_func1("obj_is_openable", obj)
 #define obj_under_cursor(onlyCritter, includeDude)              sfall_func2("obj_under_cursor", onlyCritter, includeDude)
 #define objects_in_radius(tile, radius, elev, type)             sfall_func4("objects_in_radius", tile, radius, elev, type)
 #define outlined_object                                         sfall_func0("outlined_object")
@@ -346,11 +351,13 @@
 #define set_object_data(obj, offset, value)                     sfall_func3("set_object_data", obj, offset, value)
 #define set_outline(obj, color)                                 sfall_func2("set_outline", obj, color)
 #define set_quest_failure_value(gvar, threshold)                sfall_func2("set_quest_failure_value", gvar, threshold)
+#define set_scr_name(name)                                      sfall_func1("set_scr_name", name)
 #define set_terrain_name(x, y, name)                            sfall_func3("set_terrain_name", x, y, name)
 #define set_town_title(areaID, title)                           sfall_func2("set_town_title", areaID, title)
 #define set_unique_id(obj)                                      sfall_func1("set_unique_id", obj)
 #define set_unjam_locks_time(time)                              sfall_func1("set_unjam_locks_time", time)
 #define set_window_flag(winID, flag, value)                     sfall_func3("set_window_flag", winID, flag, value)
+#define show_win                                                sfall_func0("show_window")
 #define show_window(winName)                                    sfall_func1("show_window", winName)
 #define spatial_radius(obj)                                     sfall_func1("spatial_radius", obj)
 #define string_compare(str1, str2)                              sfall_func2("string_compare", str1, str2)
@@ -361,8 +368,25 @@
 #define tile_by_position(x, y)                                  sfall_func2("tile_by_position", x, y)
 #define tile_refresh_display                                    sfall_func0("tile_refresh_display")
 #define unjam_lock(obj)                                         sfall_func1("unjam_lock", obj)
+#define unset_scr_name                                          sfall_func0("set_scr_name") /* sets the name of the script object from pro_*.msg instead of scrname.msg */
 #define unset_unique_id(obj)                                    sfall_func2("set_unique_id", obj, -1)
 #define unwield_slot(critter, slot)                             sfall_func2("unwield_slot", critter, slot)
 #define win_fill_color(x, y, width, height, color)              sfall_func5("win_fill_color", x, y, width, height, color)
 
+
+/* SFALL METARULE3 FUNCTION MACROS */
+
+// sets the number of days (range 1...127) for the Frank Horrigan encounter, or disable the encounter if days is set to 0
+#define set_horrigan_days(day)                                  metarule3(200, day, 0, 0)
+// clears the keyboard input buffer, use it in the HOOK_KEYPRESS hook to clear keyboard events before calling functions that are waiting for keyboard input
+#define clear_keyboard_buffer                                   metarule3(201, 0, 0, 0)
+
+// functions to control the save slot
+// Note: slot value here is 0-indexed instead of 1-indexed displayed in game and used for folder names
+#define get_current_save_slot                                   metarule3(210, 0, 0, 0) // returns the amount: page + slot
+#define set_current_save_slot(page, slot)                       metarule3(211, page, slot, 0)
+#define get_current_quick_save_page                             metarule3(212, 0, 0, 0)
+#define get_current_quick_save_slot                             metarule3(213, 0, 0, 0)
+#define set_current_quick_save_slot(page, slot, check)          metarule3(214, page, slot, check) // check: 1 - don't check slot when saving
+
 #endif

artifacts/scripting/hookscripts.md

@@ -87,7 +87,7 @@ The defines to use for the hookID are in **sfall.h**.
 
 #### `HOOK_TOHIT (hs_tohit.int)`
 
-Runs when Fallout is calculating the chances of an attack striking a target.
+Runs when Fallout is calculating the chances of an attack striking a target.<br>
 Runs after the hit chance is fully calculated normally, including applying the 95% cap.
 
 ```
@@ -125,8 +125,8 @@ Critter ret2 - Override the target of the attack
 
 #### `HOOK_CALCAPCOST (hs_calcapcost.int)`
 
-Runs whenever Fallout is calculating the AP cost of using the weapon (or unarmed attack). Doesn't run for using other item types or moving.
-Note that the first time a game is loaded, this script doesn't run before the initial interface is drawn, so if the script effects the AP cost of whatever is in the player's hands at the time the wrong AP cost will be shown. It will be fixed the next time the interface is redrawn.
+Runs whenever Fallout is calculating the AP cost of using the weapon (or unarmed attack). Doesn't run for using other item types or moving.<br>
+Note that the first time a game is loaded, this script doesn't run before the initial interface is drawn, so if the script effects the AP cost of whatever is in the player's hands at the time the wrong AP cost will be shown. It will be fixed the next time the interface is redrawn.<br>
 You can get the weapon object by checking item slot based on attack type (`ATKTYPE_LWEP1`, `ATKTYPE_LWEP2`, etc) and then calling `critter_inven_obj`.
 
 ```
@@ -144,6 +144,7 @@ int     ret0 - The new AP cost
 #### `HOOK_DEATHANIM1 (hs_deathanim1.int)`
 
 Runs before Fallout tries to calculate the death animation. Lets you switch out which weapon Fallout sees.
+
 Does not run for critters in the knockdown/out state.
 
 ```
@@ -160,8 +161,9 @@ int     ret0 - The pid of an object to override the attacking weapon with
 
 #### `HOOK_DEATHANIM2 (hs_deathanim2.int)`
 
-Runs after Fallout has calculated the death animation. Lets you set your own custom frame id, so more powerful than `HOOK_DEATHANIM1`, but performs no validation.
+Runs after Fallout has calculated the death animation. Lets you set your own custom frame id, so more powerful than `HOOK_DEATHANIM1`, but performs no validation.<br>
 When using `critter_dmg` function, this script will also run. In that case weapon pid will be -1 and attacker will point to an object with `obj_art_fid == 0x20001F5`.
+
 Does not run for critters in the knockdown/out state.
 
 ```
@@ -220,7 +222,7 @@ Critter arg0 - The critter that just died
 
 #### `HOOK_FINDTARGET (hs_findtarget.int)`
 
-Runs when the AI is trying to pick a target in combat. Fallout first chooses a list of 4 likely suspects, then normally sorts them in order of weakness/distance/etc depending on the AI caps of the attacker.
+Runs when the AI is trying to pick a target in combat. Fallout first chooses a list of 4 likely suspects, then normally sorts them in order of weakness/distance/etc depending on the AI caps of the attacker.<br>
 This hook replaces that sorting function, allowing you to sort the targets in some arbitrary way.
 
 The return values can include critters that weren't in the list of possible targets, but the additional targets may still be discarded later on in the combat turn if they are out of the attackers perception or the chance of a successful hit is too low. The list of possible targets often includes duplicated entries, but this is fixed in sfall 4.2.3/3.8.23.
@@ -250,7 +252,7 @@ Critter ret3 - The fourth choice of target
 #### `HOOK_USEOBJON (hs_useobjon.int)`
 
 Runs when:
-1) a critter uses an object on another critter. (Or themselves)
+1) a critter uses an object on another critter (or themselves).
 2) a critter uses an object from inventory screen AND this object does not have "Use" action flag set and it's not active flare or explosive.
 3) player or AI uses any drug
 
@@ -340,10 +342,10 @@ int     ret0 - the new AP cost
 -------------------------------------------
 
 #### DEPRECATED HOOKS:
-* `HOOK_HEXMOVEBLOCKING  (hs_hexmoveblocking.int)`
-* `HOOK_HEXAIBLOCKING    (hs_hexaiblocking.int)`
-* `HOOK_HEXSHOOTBLOCKING (hs_hexshootblocking.int)`
-* `HOOK_HEXSIGHTBLOCKING (hs_hexsightblocking.int)`
+##### `HOOK_HEXMOVEBLOCKING  (hs_hexmoveblocking.int)`
+##### `HOOK_HEXAIBLOCKING    (hs_hexaiblocking.int)`
+##### `HOOK_HEXSHOOTBLOCKING (hs_hexshootblocking.int)`
+##### `HOOK_HEXSIGHTBLOCKING (hs_hexsightblocking.int)`
 
 Run when checking to see if a hex blocks movement or shooting. (or ai-ing, presumably...)
 
@@ -501,7 +503,7 @@ int     ret0 - overrides the returned result of the function:
 
 #### `HOOK_INVENTORYMOVE (hs_inventorymove.int)`
 
-Runs before moving items between inventory slots in dude interface. You can override the action.
+Runs before moving items between inventory slots in dude interface. You can override the action.<br>
 What you can NOT do with this hook:
 - force moving items to inappropriate slots (like gun in armor slot)
 
@@ -531,7 +533,7 @@ int     ret0 - Override setting (-1 - use engine handler, any other value - prev
 
 #### `HOOK_INVENWIELD (hs_invenwield.int)`
 
-Runs before causing a critter or the player to wield/unwield an armor or a weapon (except when using the inventory by PC).
+Runs before causing a critter or the player to wield/unwield an armor or a weapon (except when using the inventory by PC).<br>
 An example usage would be to change critter art depending on armor being used or to dynamically customize weapon animations.
 
 __NOTE:__ When replacing a previously wielded armor or weapon, the unwielding hook will not be executed.
@@ -551,7 +553,7 @@ int     ret0 - overrides hard-coded handler (-1 - use engine handler, any other
 
 #### `HOOK_ADJUSTFID (hs_adjustfid.int)`
 
-Runs after calculating character figure FID on the inventory screen, whenever the game decides that character appearance might change.
+Runs after calculating character figure FID on the inventory screen, whenever the game decides that character appearance might change.<br>
 Also happens on other screens, like barter.
 
 __NOTE:__ FID has following format: `0x0ABBCDDD`, where: `A` - object type, `BB` - animation code (always 0 in this case), `C` - weapon code, `DDD` - FRM index in LST file.

artifacts/scripting/sfall function notes.md

@@ -924,7 +924,7 @@ sfall_funcX metarule functions
 - `winType`: the type number of the interface window (see `WINTYPE_*` constants in **sfall.h**)
 - `x/y`: offset relative to the top-left corner of the window
 - `color`: the color index in the game palette. Pass 0 if the text color was previously set by vanilla `SetTextColor` function. It can also take additional flags (via `bwor`) for displaying text:<br>
-    `0x0010000` - adds a shadow to the text, the 'textshadow' compiler constant<br>
+    `0x0010000` - adds a shadow to the text, the `textshadow` compiler constant<br>
     `0x1000000` - prevents immediate redrawing of the interface window, the `textdirect` compiler constant (works the other way around)<br>
     `0x2000000` - fills the background of the text with black color, the `textnofill` compiler constant (works the other way around)
 
@@ -963,6 +963,19 @@ sfall_funcX metarule functions
 - `gvarNumber`: the number of the global variable controlling the quest
 - `thresholdValue`: the value of the global variable at which the quest is counted as a failure
 
+----
+#### set_scr_name
+`void sfall_func1("set_scr_name", string name)`
+- Overrides the name of the script object that was set from **scrname.msg**
+- The changed name will be reset each time the player leaves the map or reloads the game
+- Passing an empty string ("") to the `name` argument or omitting it will allow the game to get the name for the object from pro_*.msg files
+- __NOTE:__ this function is intended for use in normal game scripts and overrides the name only once for the same object until reset
+
+----
+#### obj_is_openable
+`bool sfall_func1("obj_is_openable", object obj)`
+- Returns True if the object is openable (i.e. has an opening/closing animation)
+
 
 ****
 _See other documentation files (arrays.md, hookscripts.md) for related functions reference._

artifacts/translations/brazilian_portuguese.ini

@@ -0,0 +1,18 @@
+[sfall]
+SaveInCombat=Não pôde salvar desta vez.
+KarmaGain=Você ganhou %d de karma.
+KarmaLoss=Você perdeu %d de karma.
+HighlightFail1=Você não está carregando um sensor de movimento.
+HighlightFail2=Seu sensor de movimento está sem cargas.
+SuperStimExploitMsg=Você não pode usar este item em alguém que não esteja ferido!
+BlockedCombat=Você não pode entrar em combate desta vez.
+SaveSfallDataFail=ERRO ao salvar a informação extendida do jogo salvo! Verifique se outros programas interferem com os arquivos/pastas do jogo salvo e tente de novo.
+PartyLvlMsg=Nvl:
+PartyACMsg=CA:
+PartyAddictMsg=Viciado
+NPCPickupFail=%s não pôde pegar o item.
+
+[AppearanceMod]
+RaceText=Raça
+StyleText=Estilo
+DoneBtn=Feito

artifacts/translations/chs.ini

@@ -4,7 +4,7 @@ KarmaGain=
 KarmaLoss=你失去了%d点道德。
 HighlightFail1=你没有携带动态感应器。
 HighlightFail2=你的动态感应器没电了。
-SuperStimExploitMsg=你不能对没受伤的人使用超级治疗针！
+SuperStimExploitMsg=你不能对没受伤的角色使用这个物品！
 BlockedCombat=你现在不能进入战斗。
 SaveSfallDataFail=储存存档延展信息时发生错误！检查是否有其他程序占用存档文件／文件夾之后再试一次。
 PartyLvlMsg=等级:
@@ -16,3 +16,20 @@ NPCPickupFail=%s
 RaceText=种族
 StyleText=风格
 DoneBtn=完成
+
+;玩家空手攻击招式的自定名称（最长为16个字元，8个中文字）
+[Unarmed]
+;Punch=拳击:
+;Kick=踢击:
+;StrongPunch=重拳:
+;HammerPunch=榔头拳:
+;Haymaker=强拳:
+;Jab=刺拳:
+;PalmStrike=掌击:
+;PiercingStrike=刺击:
+;StrongKick=重踢:
+;SnapKick=快踢:
+;PowerKick=强踢:
+;HipKick=背踢:
+;HookKick=勾踢:
+;PiercingKick=刺踢:

artifacts/translations/cht.ini

@@ -4,7 +4,7 @@ KarmaGain=
 KarmaLoss=你失去了%d點道德。
 HighlightFail1=你沒有攜帶動態感應器。
 HighlightFail2=你的動態感應器沒電了。
-SuperStimExploitMsg=你不能對沒受傷的角色使用超級治療針！
+SuperStimExploitMsg=你不能對沒受傷的角色使用這個物品！
 BlockedCombat=你現在不能進入戰鬥。
 SaveSfallDataFail=儲存存檔延伸資訊時發生錯誤！檢查是否有其他程式占用存檔檔案／資料夾之後再試一次。
 PartyLvlMsg=等級:
@@ -16,3 +16,20 @@ NPCPickupFail=%s
 RaceText=種族
 StyleText=風格
 DoneBtn=完成
+
+;玩家空手攻擊招式的自定名稱（最長為16個字元，8個中文字）
+[Unarmed]
+;Punch=拳擊:
+;Kick=踢擊:
+;StrongPunch=重拳:
+;HammerPunch=榔頭拳:
+;Haymaker=強拳:
+;Jab=刺拳:
+;PalmStrike=掌擊:
+;PiercingStrike=刺擊:
+;StrongKick=重踢:
+;SnapKick=快踢:
+;PowerKick=強踢:
+;HipKick=背踢:
+;HookKick=勾踢:
+;PiercingKick=刺踢:

artifacts/translations/french.ini

@@ -1,18 +1,18 @@
 [sfall]
 SaveInCombat=Tu ne peux pas sauvegarder en ce moment.
-KarmaGain=Tu gagnes %d Karma.
-KarmaLoss=Tu perds %d Karma.
-HighlightFail1=Tu n'as pas de détecteur de mouvement.
-HighlightFail2=Ton détecteur de mouvement n'a plus de charges.
-SuperStimExploitMsg=You cannot use a super stim on someone who is not injured!
-BlockedCombat=You cannot enter combat at this time.
-SaveSfallDataFail=ERROR saving extended savegame information! Check if other programs interfere with savegame files/folders and try again.
-PartyLvlMsg=Suiv:
-PartyACMsg=TA:
-PartyAddictMsg=Dependance
-NPCPickupFail=%s ne peut pas ramasser l'objet.
+KarmaGain=Tu gagnes %d points de Karma.
+KarmaLoss=Tu perds %d points de Karma.
+HighlightFail1=Tu ne porte pas de Capteur de mouvement.
+HighlightFail2=Ton Capteur de mouvement est vide.
+SuperStimExploitMsg=Tu ne peux pas utiliser cet objet sur une personne qui n'est pas blessée!
+BlockedCombat=Tu ne peux pas entrer en combat actuellement.
+SaveSfallDataFail=ERROR à la sauvegarde! Vérifiez que d'autres programmes n'interferent pas avec les fichiers ou les dossiers de sauvegarde et essayez à nouveau.
+PartyLvlMsg=Niveau:
+PartyACMsg=CA:
+PartyAddictMsg=Accroc
+NPCPickupFail=%s ne peux pas prendre cet objet.
 
 [AppearanceMod]
 RaceText=Race
 StyleText=Style
-DoneBtn=Fait
+DoneBtn=Terminé

artifacts/translations/german.ini

@@ -4,7 +4,7 @@ KarmaGain=Du erh
 KarmaLoss=Du verlierst %d Karma.
 HighlightFail1=Du trägst keinen Bewegungssensor.
 HighlightFail2=Dein Bewegungssensor ist entladen.
-SuperStimExploitMsg=Du kannst einem Unverletzten kein Super-Stimpak verabreichen!
+SuperStimExploitMsg=Du kannst diesen Gegenstand nicht auf Unverletzte anwenden!
 BlockedCombat=Kampfmodus momentan nicht verfügbar.
 SaveSfallDataFail=FEHLER beim Speichern des Spielstandes! Prüfe, ob andere Programme darauf zugreifen und probiere es erneut.
 PartyLvlMsg=Lvl:
@@ -16,3 +16,20 @@ NPCPickupFail=%s kann das Objekt nicht nehmen.
 RaceText=Geschlecht
 StyleText=Stil
 DoneBtn=OK
+
+;Custom names for player's unarmed attacks (max 16 characters)
+[Unarmed]
+;Punch=Boxen:
+;Kick=Tretten:
+;StrongPunch=Starker Hieb:
+;HammerPunch=Hammerschlag:
+;Haymaker=Heumacher:
+;Jab=
+;PalmStrike=
+;PiercingStrike=
+;StrongKick=Starker Tritt:
+;SnapKick=
+;PowerKick=
+;HipKick=
+;HookKick=
+;PiercingKick=

artifacts/translations/polish.ini

@@ -0,0 +1,18 @@
+[sfall]
+SaveInCombat=Nie możesz zapisać gry w tym momencie.
+KarmaGain=Zdobyłeś %d karmy.
+KarmaLoss=Straciłeś %d karmy.
+HighlightFail1=Nie masz przy sobie detektora ruchu.
+HighlightFail2=Twój detektor ruchu jest rozładowany.
+SuperStimExploitMsg=Nie możesz użyć tego przedmiotu na w pełni zdrowej osobie!
+BlockedCombat=Nie możesz obecnie wejść w tryb walki.
+SaveSfallDataFail=BŁĄD Zapisujesz rozszerzone informacje w zapisie gry! Sprawdź, czy inne programy nie kolidują z plikami/folderami zapisu gry i spróbuj ponownie.
+PartyLvlMsg=Lvl:
+PartyACMsg=AC:
+PartyAddictMsg=Uzależniony
+NPCPickupFail=%s nie może podnieść przedmiotu.
+
+[AppearanceMod]
+RaceText=Rasa
+StyleText=Styl
+DoneBtn=Gotowe

artifacts/translations/russian.ini

@@ -4,8 +4,8 @@ KarmaGain=
 KarmaLoss=Вы теряете %d единиц кармы.
 HighlightFail1=Сенсор движения недоступен.
 HighlightFail2=Сенсор движения разряжен.
-SuperStimExploitMsg=Вы не можете использовать суперстимулятор на здоровом персонаже!
-BlockedCombat=Вы не можете сейчас начать бой.
+SuperStimExploitMsg=Вы не можете использовать этот предмет на здоровом персонаже!
+BlockedCombat=Начать бой в данный момент невозможно.
 SaveSfallDataFail=ОШИБКА записи расширенной информации! Убедитесь что другие программы не обращаются к файлам/каталогам сохраняемой игры и попробуйте еще раз.
 PartyLvlMsg=Ур.:
 PartyACMsg=КБ:
@@ -16,3 +16,20 @@ NPCPickupFail=%s
 RaceText=Раса
 StyleText=Стиль
 DoneBtn=Закрыть
+
+;Имена для невооруженных атак игрока (макс. 16 символов)
+[Hits]
+;Punch=Удар рукой:
+;Kick=Удар ногой:
+;StrongPunch=
+;HammerPunch=
+;Haymaker=
+;Jab=
+;PalmStrike=
+;PiercingStrike=
+;StrongKick=
+;SnapKick=
+;PowerKick=
+;HipKick=
+;HookKick=
+;PiercingKick=