Moved LoadHeroAppearance() from MainMenuHook to NewGame2. No reason to run it on the main menu where player appearance can't display.

Edited code style in HeroAppearance.cpp/h, also removed some redundant blank lines.
Added descriptions for the variables in Perks.ini.
2026-07-27 16:52:34 -07:00 · 2017-09-19 15:27:08 +08:00 · 2017-09-19 10:43:31 +08:00 · 2017-09-12 15:39:39 +08:00 · 2017-09-09 18:59:21 +08:00 · 2017-09-05 09:21:22 +08:00
89 changed files with 7180 additions and 3202 deletions
@@ -7,6 +7,34 @@
 ; have an additional NoHardcode option in this file which can
 ; be used to remove their hardcoded effects, and add new stat/skill effects

+;Name=The name of the perk
+;Desc=The description of the perk
+;Image=The line number (0-indexed) of the corresponding FRM in skilldex.lst
+;Ranks=The number of perk levels
+;Level=The minimum required level
+;Type=If 0, the perk checks only Skill1 for skill requirements; if 1, it checks
+; Skill1 or Skill2; if 2, it checks both Skill1 and Skill2
+;Stat=The modified stat or -1 if you don't want to change any stats
+;StatMag=The increased/decreased value to the modified stat
+;Skill1=The first skill (or -1 for none) to check, but if you set a specific bit
+; (67108864 or 0x4000000), it checks GVAR. For example, if Skill1=67108864, then
+; the perk will check GVAR_PLAYER_REPUTATION (67108864 + 0) on Skill1Mag value
+;Skill1Mag=Positive value is used as the minimum requirements of the first
+; skill/GVAR, and a negative value is interpreted as the maximum requirement.
+; For example, with Skill1=0 and Skill1Mag=100, if player has small guns skill
+; >= 100 and meets all other requirements, the perk will be available in the
+; selection window; with Skill1=1 and Skill1Mag=-120, the perk will not be
+; available if player has big guns skill >= 120
+;Skill2=The second skill/GVAR (or -1 for none) to check
+;Skill2Mag=Same as Skill1Mag, but for Skill2
+;STR-LCK=Positive values are used as minimum requirements of SPECIAL stats, and
+; negative values are interpreted as maximum requirements. For some special
+; perks processed by the engine (e.g. PERK_armor_powered and PERK_armor_combat),
+; the values are not used as requirements but to add to corresponding SPECIAL
+; stats
+
+;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
@@ -36,4 +64,4 @@ Name=Example
 Desc=This is an example trait
 Image=72
 StatMod=0|-1 ;Subtract 1 from strength
-SkillMod=0|20|1|-5 ;Add 20 to the players small guns skill and subtract 5 from big guns
+SkillMod=0|20|1|-5 ;Add 20 to the player's small guns skill and subtract 5 from big guns
@@ -1,5 +1,5 @@
 ;sfall configuration settings
-;v3.7a
+;v3.8.5

 [Main]
 ;Change to 1 if you want to use command line args to tell sfall to use another ini file.
@@ -48,26 +48,26 @@ SpeedMultiInitial=100
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Graphics]
 ;Set to 0 for 8 bit fullscreen
-;Set to 4 for dx9 fullscreen
-;Set to 5 for dx9 windowed
-;A dx9 mode is required for any graphics related script extender functions to work (i.e. fullscreen shaders)
+;Set to 4 for DX9 fullscreen
+;Set to 5 for DX9 windowed
+;A DX9 mode is required for any graphics related script extender functions to work (i.e. fullscreen shaders)
 ;Modes 1, 2 and 3 are no longer supported
 Mode=0

-;If using a dx9 mode, this changes the resolution
+;If using a DX9 mode, this changes the resolution
 ;The graphics are simply stretched to fit the new window; this does _not_ let you see more of the map
 ;If set to 0, use Fallout's native resolution
 GraphicsWidth=0
 GraphicsHeight=0

-;Set to 1 to do the palette conversion on the gpu
-;Set to 2 to do the palette conversion on the cpu
+;Set to 1 to do the palette conversion on the GPU
+;Set to 2 to do the palette conversion on the CPU
 ;Set to 0 to pick automatically
 ;GPU is faster, but requires v2.0 pixel shader support
 GPUBlt=0

 ;Set to 1 to allow using 32 bit graphics for talking heads
-;Requires graphics mode 4 or 5, and gpublt set to 1
+;Requires graphics mode 4 or 5, and GPUBlt set to 1
 Use32BitHeadGraphics=0

 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -98,7 +98,7 @@ ReverseMouseButtons=0
 BackgroundKeyboard=0
 BackgroundMouse=0

-;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

 ;The modifier key you have to hold down to change any speed settings
 ;Set to 0 if you don't want to use a modifier key, or a DX scancode otherwise
@@ -131,16 +131,25 @@ WindowScrollKey=0
 ToggleItemHighlightsKey=42

 ;Set to 1 to also highlight containers
-;Set to 2 for purple outlines
 HighlightContainers=0

+;Set the color of outlines, available colors:
+;0x01 - glowing red
+;0x02 - red
+;0x04 - grey
+;0x08 - glowing green
+;0x10 - bright yellow
+;0x20 - dark yellow
+;0x40 - purple
+OutlineColor=0x10
+
 ;A key to press to reload your currently equipped weapon
 ReloadWeaponKey=0

 ;A key to press to open a debug game editor
 DebugEditorKey=0

-;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Misc]

 ;Time limit in years. Must be between -3 and 13
@@ -164,24 +173,10 @@ WorldMapFPSPatch=1
 ;Controls the world map speed if WorldMapFPSPatch is 1. Higher values cause slower movement
 WorldMapDelay2=66

-;XX OBSOLETE  XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-;XX 
-;XX ;This will change the physical speed at which you move across the map
-;XX ;Set to 0 to leave at the default. (i.e. limited by vwait in windowed mode, or by processor speed in fullscreen)
-;XX ;If set to something other than 0, it enforces a maximum fps on the world map screen.
-;XX ;Changing this to something other than 0 is not recommended if you've already applied a world map speed patch to your Fallout exe.
-;XX WorldMapFPS=0
-;XX 
-;XX ;Only set to 1 if your systems high performance timer is unreliable for some reason
-;XX ForceLowResolutionTimer=0
-;XX 
-;XX ;Set to 1 to enable Ray's patch to make world map encounter rate independent of your travel speed
-;XX WorldMapEncounterFix=0
-;XX WorldMapEncounterRate=6
-;XX 
-;XX ;Obsolete, but can still be used if you know what it does.
-;XX ;WorldMapDelay=0
-;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+;Set to 1 to enable Ray's patch to make world map encounter rate independent of your travel speed
+;Higher values of WorldMapEncounterRate cause a slower encounter rate
+WorldMapEncounterFix=0
+WorldMapEncounterRate=5

 ;The number of slots available in the locations list panel of the world map
 ;Set to 0 to leave unchanged. 17 is default.
@@ -201,9 +196,14 @@ WorldMapSlots=0
 ;To use a patch file other than patch000.dat, uncomment the next line and add your new file name
 ;If you want to check for multiple patch files, you can include a %d in the file name (sprintf syntax)
 ;By default, only the first patch file found will be used.
-;If you want to load multiple patch files at once, uncomment the NumberPatchLoop line and set it to the number of files to check for
+;If you want to load multiple patch files (up to 1000) at once, uncomment the MultiPatches line and set it to 1
 ;PatchFile=patch%03d.dat
-;NumberPatchLoop=100
+;MultiPatches=0
+
+;Set to 1 to enable the modified data load order for the engine to find game data
+;Original: patchXXX.dat > critter_patches > critter_dat > f2_res_patches > f2_res_dat > master_patches > master_dat
+;Modified: master_patches > critter_patches > patchXXX.dat > critter_dat > f2_res_patches > f2_res_dat > master_dat
+DataLoadOrderPatch=0

 ;To change the default and starting player models, uncomment the next four lines.
 ;The default models can also be changed ingame via script
@@ -233,6 +233,7 @@ Movie16=artimer4.mve
 Movie17=credits.mve

 ;To change the starting year, month or day, uncomment the next 3 lines
+;Both StartMonth and StartDay are 0-indexed
 ;StartYear=-1
 ;StartMonth=-1
 ;StartDay=-1
@@ -247,11 +248,12 @@ Movie17=credits.mve
 ;PerksFile=Perks.ini

 ;Set to 1 if you want the pipboy to be available at the start of the game
+;Set to 2 to make the pipboy available by only skipping the vault suit movie check
 PipBoyAvailableAtGameStart=0

 ;Set to 1 to double the number of available kill types
 ;If you use this, you need to provide the extra descriptions in proto.msg (entries from 1450 to 1487 are names and 1488 to 1525 are descriptions)
-;Changing this option mid game will not invalidate old save games, but the players kill counters will be completely screwed.
+;Changing this option mid game will not invalidate old save games, but the player's kill counters will be completely screwed.
 ;Setting this to 1 may cause problems if the player kills more than 32767 of any one critter type
 ;Additional kill types must have their new critical tables set! (See the OverrideCriticalTable option)
 ExtraKillTypes=0
@@ -273,8 +275,8 @@ TownMapHotkeysFix=1
 ;Set to 1 to disable the horrigan encounter
 DisableHorrigan=0

-;Set to 1 to disable the random element in npc levelling.
-;This will cause all npc party members to automatically level up as soon as the player reaches the requirements
+;Set to 1 to disable the random element in NPC levelling.
+;This will cause all NPC party members to automatically level up as soon as the player reaches the requirements
 NPCAutoLevel=0

 ;Change the initial starting location and world map viewport
@@ -290,9 +292,6 @@ SingleCore=1
 ;Set to 1 to override the art_chache_size setting in fallout2.cfg
 OverrideArtCacheSize=0

-;Set to 1 to fix issues with the GainXXX perks not giving all the bonuses that they should
-GainStatPerkFix=1
-
 ;Prevents you from saving in combat except at the start of your turn to avoid a few bugs
 ;Note that even with this option enabled, it is still not advisable to save in combat at all.
 ;Set to 2 to block all saving in combat
@@ -301,8 +300,8 @@ SaveInCombatFix=1
 ;Point at an ini file containing elevator data
 ;ElevatorsFile=Elevators.ini

-;Uncomment and set to a comma delimited list of numbers to use a custom xp table.
-;Players level is capped once the highest specified level is reached
+;Uncomment and set a comma delimited list of numbers to use a custom xp table.
+;Player's level is capped once the highest specified level is reached
 ;XPTable=50,100,200

 ;Set to 1 to enable additional weapon animations codes from o-t
@@ -311,15 +310,14 @@ SaveInCombatFix=1
 AdditionalWeaponAnims=1

 ;Uncomment these lines to modify the default modifiers for aimed shots at specific bodyparts
-;BodypartHitMod0=-40
-;BodypartHitMod1=-30
-;BodypartHitMod2=-30
-;BodypartHitMod3=0
-;BodypartHitMod4=-20
-;BodypartHitMod5=-20
-;BodypartHitMod6=-60
-;BodypartHitMod7=-30
-;BodypartHitMod8=0
+;BodyHit_Head=-40
+;BodyHit_Left_Arm=-30
+;BodyHit_Right_Arm=-30
+;BodyHit_Torso_Uncalled=0
+;BodyHit_Right_Leg=-20
+;BodyHit_Left_Leg=-20
+;BodyHit_Eyes=-60
+;BodyHit_Groin=-30

 ;Set to 1 to use a CriticalOverrides.ini file to override the default critical table
 ;Set to 2 to use the default critical with bug fixes (doesn't require an ini)
@@ -343,7 +341,7 @@ CorpseLineOfFireFix=0
 ;Set a number of milliseconds to idle each input loop
 ;Set to -1 to disable
 ;Set to 0 to idle only if other processes are waiting for processor time
-;Set to 1 (or some higher number if needed) to prevent 100% cpu use
+;Set to 1 (or some higher number if needed, the maximum is 127) to prevent 100% CPU use
 ProcessorIdle=-1

 ;Set to 1 if using the hero appearance mod
@@ -352,17 +350,17 @@ EnableHeroAppearanceMod=0
 ;Set to 1 to skip the 3 opening movies
 SkipOpeningMovies=0

-;Causes npc's who complete their combat turn with ap left over will try and find other ways to spend it.
-;Only npcs with ap left equal to or greater than the value given here will be considered.
+;Causes NPCs who complete their combat turn with ap left over will try and find other ways to spend it.
+;Only NPCs with ap left equal to or greater than the value given here will be considered.
 ;Set to 0 to disable
 NPCsTryToSpendExtraAP=0

 ;Allows the use of tiles over 80*36 in size. sfall will just split and resave them at startup
 ;Set to 1 to check all tiles on started (slow)
-;set to 2 if you provide a XLtiles.lst file in art/tiles/ containing a list of the tile ids that need checking
+;Set to 2 if you provide a XLtiles.lst file in art/tiles/ containing a list of the tile ids that need checking
 AllowLargeTiles=0

-;Change the skilldex cursor frm numbers
+;Change the Skilldex cursor frm numbers
 ;Default is 293 for all skills
 Lockpick=293
 Steal=293
@@ -384,7 +382,7 @@ UseScrollingQuestsList=1
 ;PremadeFIDs=201,203,202

 ;Use this line to modify the list of cities and their associated global variables used for city reputations
-;Syntax is 'city id : global id',with each city/global pair separated by a comma.
+;Syntax is 'city id : global id', with each city/global pair separated by a comma.
 ;CityRepsCount=19
 ;CityRepsList=0:47,2:48,1:49,4:50,5:51,3:52,8:53,6:54,7:55,13:56,10:57,11:59,14:61,17:63,19:64,18:65,25:66,9:294,20:308

@@ -394,10 +392,12 @@ UseScrollingQuestsList=1
 ;Set to 1 to add additional pages of save slots
 ExtraSaveSlots=0

-;Set to 1 to speed up the hp/ac counter animations
+;Set to 1 to speed up the HP/AC counter animations
+;Set to 2 to update the HP/AC counters instantly
 SpeedInterfaceCounterAnims=0

 ;These lines allow you to control the karma frm's displayed on the character screen
+;Number of KarmaPoints should be 1 less than number of KarmaFRMs
 ;KarmaFRMsCount=3
 ;KarmaFRMs=47,48,49
 ;KarmaPoints=-100,100
@@ -405,7 +405,7 @@ SpeedInterfaceCounterAnims=0
 ;Set to 1 to allow science and repair to be used on the player, or 2 for all critters. (Rather than only brahmin/robots)
 ScienceOnCritters=0

-;Modify this value to change the players speed of rotation on the inventory and character screens
+;Modify this value to change the player's speed of rotation on the inventory and character screens
 ;Default is 166
 SpeedInventoryPCRotation=166

@@ -419,7 +419,7 @@ BonusHtHDamageFix=1
 ;Set to 1 to display additional points of damage from Bonus HtH/Ranged Damage perks in the inventory
 DisplayBonusDamage=0

-;Modify the maximum number of animations allowed to run on a map. (Default is 32)
+;Modify the maximum number of animations allowed to run on a map. (Default is 32, and the maximum is 127)
 AnimationsAtOnceLimit=120

 ;Set to 1 to remove the limits that stop the player rolling critical successes/misses in the first few days of game time
@@ -428,11 +428,8 @@ RemoveCriticalTimelimits=0
 ;Set to 1 to enable party members with level 6 protos to reach level 6
 NPCStage6Fix=0

-;Set to 1 to fix the problem with melee weapon equiped npcs being unable to attack multi-hex critters
-MultiHexPathingFix=1
-
 ;Change the colour of the font used on the main menu for the Fallout/sfall version number
-;It's the last byte ('3c' by default,) that picks the colour used. The first byte supplies additional flags
+;It's the last byte ('3c' by default) that picks the colour used. The first byte supplies additional flags
 ;MainMenuFontColour=0x0600003c

 ;Two alternate fixes to the interaction between HtH attacks and the fast shot trait
@@ -453,7 +450,7 @@ BoostScriptDialogLimit=0
 ;DerivedStats=Stats.ini

 ;These options modify the checks to see if a critter can carry an additional item, changing which items are counted towards the weight limit and adding an additional size check
-;Set the mode to 0 to disable the size check, 1 to apply to pc only, 2 to apply to the pc and party members, or 3 to apply to all critters
+;Set the mode to 0 to disable the size check, 1 to apply to the PC only, 2 to apply to the PC and party members, or 3 to apply to all critters
 ;Only the PC uses CritterInvSizeLimit. Other critters will use the extra unused stat (STAT_unused = 10)
 ;Add 4 to the mode to limit the weight check to used items only
 CritterInvSizeLimitMode=0
@@ -472,6 +469,12 @@ EncounterTableSize=0
 ;Set to 1 to disable the pipboy alarm button
 DisablePipboyAlarm=0

+;Uncomment the next four lines to move the main menu buttons and credit text (the 'Copyright(c)' line on the main menu)
+;MainMenuOffsetX=0
+;MainMenuOffsetY=0
+;MainMenuCreditsOffsetX=0
+;MainMenuCreditsOffsetY=0
+
 ;Prevents you from using super stims on a critter who is at full health.
 SuperStimExploitFix=0

@@ -482,13 +485,15 @@ QuickPocketsApCostReduction=2
 ;Set to 1 to allow objects seeing through other objects with their ShootThru flag set
 ObjCanSeeObj_ShootThru_Fix=0

-;These options change the bullet distribution of burst attacks
-;All the bullets are divided into three groups: central, left and right. These three groups will then travel along three parallel tracks, trying to hit targets on the way
-;Set the mod to 1 to enable the next four lines
+;Set to 1 to enable the balanced bullet distribution formula for burst attacks
+ComputeSprayMod=0
+
+;These options modify the bullet distribution of burst attacks if ComputeSprayMod is 1
+;All the bullets are divided into three groups: central, left and right
+;These three groups will then travel along three parallel tracks, trying to hit targets on the way
 ;CenterMult/Div set the ratio of how many bullets go to the central group, and remaining bullets are divided equally to left and right sides
 ;TargetMult/Div set the ratio of how many bullets in the central group will attack the primary target directly
-;Multipliers are capped at divisor values.
-ComputeSprayMod=0
+;Multipliers are capped at divisor values
 ComputeSpray_CenterMult=1
 ComputeSpray_CenterDiv=3
 ComputeSpray_TargetMult=1
@@ -524,12 +529,14 @@ CheckWeaponAmmoCost=0
 CombatPanelAnimDelay=1000
 ;Controls the speed of dialog panel animations (lower - faster; valid range: 0..255)
 DialogPanelAnimDelay=33
+;Controls the speed of pipboy alarm clock animations (lower - faster; valid range: 0..127)
+PipboyTimeAnimDelay=50

 ;Allows you to directly control other critters in combat
 ;Set to 0 to disable
 ;Set to 1 to control all critters in combat
 ;Set to 2 to control all party members
-;If you want to control only specific critters, uncomment the ControlCombatPIDList line and set it to a comma delimited list of PIDs
+;If you want to control only specific critters, uncomment the ControlCombatPIDList line and set a comma delimited list of PIDs
 ControlCombat=0
 ;ControlCombatPIDList=62,89,97,107,160,161

@@ -549,9 +556,28 @@ DialogOptions9Lines=1
 ;Set to 1 to leave the music playing in dialogue with talking heads
 EnableMusicInDialogue=0

+;Set to 1 to prevent the player from running while sneaking without Silent Running perk
+DontTurnOffSneakIfYouRun=0
+
 ;Set to 1 to fix the bug that unable to sell used geiger counters or stealth boys
 CanSellUsedGeiger=1

+;Set to 1 to fix the issue with being able to charge the car by using cells on other scenary/critters
+CarChargingFix=1
+
+;Set to 1 to skip weapon equip/unequip animations when performing various actions
+InstantWeaponEquip=0
+
+;To add additional game msg files, uncomment the next line and set a comma delimited list of filenames without .msg extension
+;You need to use the message_str_game script function to get messages from the files
+;ExtraGameMsgFileList=
+
+;Set to 1 to display numbered dialogue options
+NumbersInDialogue=0
+
+;Set to 1 to display sfall built-in credits at the bottom of credits.txt contents instead of at the top
+CreditsAtBottom=0
+
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Debugging]
 ;Extra sfall configuration settings that can be used by modders
@@ -560,18 +586,32 @@ CanSellUsedGeiger=1
 ;Set to 1 to enable sfall debugging mode
 Enable=0

+;Fallout 2 Debug Patch
 ;Set to 1 to enable debugging output to screen or 2 to create a debug.log file
 ;While you don't need to create an environment variable, you do still need to set the appropriate lines in fallout2.cfg
+;-------
+;[debug]
+;mode=environment
+;output_map_data_info=1
+;show_load_info=1
+;show_script_messages=1
+;show_tile_num=1
+;[sound]
+;debug=1
+;debug_sfxc=1
+;-------
 DebugMode=0

 ;Change to 1 to skip the compatibility mode check
 SkipCompatModeCheck=0

 ;Set to 1 to skip the executable file size check
+;Does not require enabling sfall debugging mode
 SkipSizeCheck=0

-;If you're testing changes to the Fallout exe, you can override the crc that sfall looks for here
+;If you're testing changes to the Fallout exe, you can override the CRC that sfall looks for here
 ;You can use several hex values, separated by commas
+;Does not require enabling sfall debugging mode
 ;ExtraCRC=0x00000000,0x00000000

 ;Set to 1 to stop Fallout from deleting non readonly protos at startup
@@ -581,7 +621,7 @@ DontDeleteProtos=0
 ;Set to 1 to give scripts direct access to Fallout's address space, and to make arbitrary calls into Fallout's code
 AllowUnsafeScripting=0

-;These options control what output is saved in the debug log
+;These options control what output is saved in the debug log (sfall-log.txt)

 ;Prints messages duing sfall initialization
 Init=0
@@ -1,22 +1,24 @@
-procedure start; 
+procedure start;
 // adjust include paths if needed
-#include "..\..\scripting_docs\headers\sfall.h" 
+#include "..\..\scripting_docs\headers\sfall.h"

 #define RESULT_SUCCESS  (1)
 #define RESULT_FAIL     (0)
- 
-procedure start begin 
-   if not init_hook then begin
+
+procedure start begin
+   if game_loaded then begin
+      register_hook(HOOK_STEAL);
+   end else begin
      variable
         thief := get_sfall_arg,
         target := get_sfall_arg,
         item := get_sfall_arg,
         action := get_sfall_arg,
         result := RESULT_SUCCESS;
-      
-      if (thief == dude_obj) then begin 
-         display_msg(sprintf(mstr_skill(570 + result + action*2), obj_name(item))); 
-         set_sfall_return(result); 
-      end 
-   end 
+
+      if (thief == dude_obj) then begin
+         display_msg(sprintf(mstr_skill(570 + result + action*2), obj_name(item)));
+         set_sfall_return(result);
+      end
+   end
 end
@@ -0,0 +1,20 @@
+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
@@ -0,0 +1,9 @@
+"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.
@@ -6,7 +6,7 @@ This folder contains documentation about sfall scripting extensions.
        dik.h - DX scancodes constants for use with key_pressed function and HOOK_KEYPRESS 
    
    sfall function notes.txt - incomplete reference for new opcodes
-    sfall function list.txt - list of all sfall opcodes (w/o descriptions)
+    sfall opcode list.txt - list of all sfall opcodes (w/o descriptions)
    hookscripts.txt - detailed manual for using hook scripts to modify engine behavior
    arrays.txt - manual for sfall arrays
    
@@ -2,16 +2,6 @@
 #ifndef DEFINE_EXTRA_H
 #define DEFINE_EXTRA_H

-#define ATTACK_MODE_NONE      0
-#define ATTACK_MODE_PUNCH     1
-#define ATTACK_MODE_KICK      2
-#define ATTACK_MODE_SWING     3
-#define ATTACK_MODE_THRUST    4
-#define ATTACK_MODE_THROW     5
-#define ATTACK_MODE_SINGLE    6
-#define ATTACK_MODE_BURST     7
-#define ATTACK_MODE_FLAME     8
-
 #define OBJ_TYPE_ITEM       (0)
 #define OBJ_TYPE_CRITTER    (1)
 #define OBJ_TYPE_SCENERY    (2)
@@ -20,18 +10,47 @@
 #define OBJ_TYPE_MISC       (5)
 #define OBJ_TYPE_SPATIAL    (6)

+/* Item Common Flags */
+#define HIDDEN_ITEM     134217728  // 0x08000000 - Hidden Item
+
+#define ITEM_ACTION_USE      2048  // 0x00000800 - Use (can be used)
+#define ITEM_ACTION_USEON    4096  // 0x00001000 - Use On Smth (can be used on anything)
+#define ITEM_ACTION_PICKUP  32768  // 0x00008000 - PickUp
+
+#define WEAPON_BIGGUN         256  // 0x00000100 - Big Gun
+#define WEAPON_2HAND          512  // 0x00000200 - 2Hnd (weapon is two-handed)
+
+#define ATKMODE_PRI_NONE        0
+#define ATKMODE_PRI_PUNCH       1
+#define ATKMODE_PRI_KICK        2
+#define ATKMODE_PRI_SWING       3
+#define ATKMODE_PRI_THRUST      4
+#define ATKMODE_PRI_THROW       5
+#define ATKMODE_PRI_SINGLE      6
+#define ATKMODE_PRI_BURST       7
+#define ATKMODE_PRI_FLAME       8
+#define ATKMODE_SEC_NONE        0
+#define ATKMODE_SEC_PUNCH      16  // 0x00000010
+#define ATKMODE_SEC_KICK       32  // 0x00000020
+#define ATKMODE_SEC_SWING      48  // 0x00000030
+#define ATKMODE_SEC_THRUST     64  // 0x00000040
+#define ATKMODE_SEC_THROW      80  // 0x00000050
+#define ATKMODE_SEC_SINGLE     96  // 0x00000060
+#define ATKMODE_SEC_BURST     112  // 0x00000070
+#define ATKMODE_SEC_FLAME     128  // 0x00000080
+
 /* Critter Flags */
-#define CFLG_BARTER             2  //0x00000002 - Barter (can trade with)
-#define CFLG_NOSTEAL           32  //0x00000020 - Steal (cannot steal 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_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_BARTER             2  // 0x00000002 - Barter (can trade with)
+#define CFLG_NOSTEAL           32  // 0x00000020 - Steal (cannot steal 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_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)

 //remove inven obj defines
 #define RMOBJ_CONSUME_DRUG        4666772
@@ -64,6 +83,7 @@
 #define PROTO_IT_SIZE       (112)
 #define PROTO_IT_WEIGHT     (116)
 #define PROTO_IT_COST       (120)
+#define PROTO_IT_INV_FID    (124)

 // weapons
 #define PROTO_WP_ANIM        (36)
@@ -140,11 +160,10 @@
 #define PROTO_DR_ADDICT_DELAY   (100)

 // critters
-#define PROTO_CR_ACTION_FLAGS    (32)
+#define PROTO_CR_FLAGS           (32)
 #define PROTO_CR_HEAD_FID        (40)
 #define PROTO_CR_AI_PACKET       (44)
 #define PROTO_CR_TEAM_NUM        (48)
-#define PROTO_CR_FLAGS           (52)
 #define PROTO_CR_BODY_TYPE      (388)
 #define PROTO_CR_KILL_EXP       (392)
 #define PROTO_CR_KILL_TYPE      (396)
@@ -205,5 +224,4 @@
 #define WPN_ANIM_MINIGUN            (0x09) // (L)
 #define WPN_ANIM_ROCKET_LAUNCHER    (0x0A) // (M)

-
 #endif // DEFINE_EXTRA_H
@@ -1,7 +1,7 @@
 #ifndef H_DIK
 #define H_DIK

-// Listed are keyboard scan code constants (in decimal), taken from dinput.h 
+// Listed are keyboard scan code constants (in decimal), taken from dinput.h

 #define DIK_ESCAPE          1
 #define DIK_1               2
@@ -14,9 +14,9 @@
 #define DIK_8               9
 #define DIK_9               10
 #define DIK_0               11
-#define DIK_MINUS           12	/* - on main keyboard */
+#define DIK_MINUS           12    /* - on main keyboard */
 #define DIK_EQUALS          13
-#define DIK_BACK			14	/* backspace */
+#define DIK_BACK            14    /* backspace */
 #define DIK_TAB             15
 #define DIK_Q               16
 #define DIK_W               17
@@ -116,20 +116,20 @@
 #define DIK_RWIN            0xDC    /* Right Windows key */
 #define DIK_APPS            0xDD    /* AppMenu key */

-#define DIK_BACKSPACE       DIK_BACK            /* backspace */
-#define DIK_NUMPADSTAR      DIK_MULTIPLY        /* * on numeric keypad */
-#define DIK_LALT            DIK_LMENU           /* left Alt */
-#define DIK_CAPSLOCK        DIK_CAPITAL         /* CapsLock */
-#define DIK_NUMPADMINUS     DIK_SUBTRACT        /* - on numeric keypad */
-#define DIK_NUMPADPLUS      DIK_ADD             /* + on numeric keypad */
-#define DIK_NUMPADPERIOD    DIK_DECIMAL         /* . on numeric keypad */
-#define DIK_NUMPADSLASH     DIK_DIVIDE          /* / on numeric keypad */
-#define DIK_RALT            DIK_RMENU           /* right Alt */
-#define DIK_UPARROW         DIK_UP              /* UpArrow on arrow keypad */
-#define DIK_PGUP            DIK_PRIOR           /* PgUp on arrow keypad */
-#define DIK_LEFTARROW       DIK_LEFT            /* LeftArrow on arrow keypad */
-#define DIK_RIGHTARROW      DIK_RIGHT           /* RightArrow on arrow keypad */
-#define DIK_DOWNARROW       DIK_DOWN            /* DownArrow on arrow keypad */
-#define DIK_PGDN            DIK_NEXT            /* PgDn on arrow keypad */
+#define DIK_BACKSPACE       DIK_BACK        /* backspace */
+#define DIK_NUMPADSTAR      DIK_MULTIPLY    /* * on numeric keypad */
+#define DIK_LALT            DIK_LMENU       /* left Alt */
+#define DIK_CAPSLOCK        DIK_CAPITAL     /* CapsLock */
+#define DIK_NUMPADMINUS     DIK_SUBTRACT    /* - on numeric keypad */
+#define DIK_NUMPADPLUS      DIK_ADD         /* + on numeric keypad */
+#define DIK_NUMPADPERIOD    DIK_DECIMAL     /* . on numeric keypad */
+#define DIK_NUMPADSLASH     DIK_DIVIDE      /* / on numeric keypad */
+#define DIK_RALT            DIK_RMENU       /* right Alt */
+#define DIK_UPARROW         DIK_UP          /* UpArrow on arrow keypad */
+#define DIK_PGUP            DIK_PRIOR       /* PgUp on arrow keypad */
+#define DIK_LEFTARROW       DIK_LEFT        /* LeftArrow on arrow keypad */
+#define DIK_RIGHTARROW      DIK_RIGHT       /* RightArrow on arrow keypad */
+#define DIK_DOWNARROW       DIK_DOWN        /* DownArrow on arrow keypad */
+#define DIK_PGDN            DIK_NEXT        /* PgDn on arrow keypad */

 #endif
@@ -0,0 +1,162 @@
+
+#ifndef LIB_INVEN_H
+#define LIB_INVEN_H
+
+#include "define_lite.h"
+
+/**
+  Inventory contents as temp array to be used in foreach
+*/
+procedure inven_as_array(variable critter) begin
+   variable i:=0, list;
+   list := temp_array(100, 4);
+   while (inven_ptr(critter, i)) do begin
+      if (i>=len_array(list)) then
+         resize_array(list, len_array(list) + 100);
+      list[i] := inven_ptr(critter, i);
+      i++;
+   end
+   resize_array(list, i);
+   return list;
+end
+
+
+procedure add_items_pid(variable who_obj, variable the_pid, variable pid_qty) begin
+   variable item;
+   item := create_object(the_pid,0,0);
+   add_mult_objs_to_inven(who_obj, item, (pid_qty));
+   return item;
+end
+
+// aliases:
+#define add_item_pid(obj, pid)            add_items_pid(obj, pid, 1)
+
+#ifndef critter_wearing_armor
+#define critter_wearing_armor(x)            (obj_item_subtype(critter_inven_obj(x,INVEN_TYPE_WORN)) == item_type_armor)
+#endif
+
+procedure unwield_armor(variable who_obj) begin
+   variable armor;
+   if (not(who_obj)) then return;
+   if (critter_wearing_armor(who_obj)) then begin
+      armor := critter_inven_obj(who_obj,INVEN_TYPE_WORN);
+      rm_obj_from_inven(who_obj, armor);
+      add_obj_to_inven(who_obj, armor);
+   end
+end
+
+procedure remove_items_pid(variable who_obj, variable the_pid, variable pid_qty) begin
+   variable begin
+      item;
+      removed_qty;
+      tmp;
+   end
+   if (not(who_obj)) then return;
+   removed_qty := obj_is_carrying_obj_pid(who_obj,the_pid);
+   if (pid_qty < removed_qty and pid_qty != -1) then begin
+      removed_qty := pid_qty;
+   end
+   if (removed_qty > 0) then begin
+      item := obj_carrying_pid_obj(who_obj, the_pid);
+      if (obj_type(who_obj) == 1) then begin
+         if (critter_inven_obj(who_obj,INVEN_TYPE_WORN) == item) then begin
+            call unwield_armor(who_obj);
+         end else if ((critter_inven_obj(who_obj, INVEN_TYPE_LEFT_HAND) == item) or (critter_inven_obj(who_obj, INVEN_TYPE_RIGHT_HAND) == item)) then begin
+            inven_unwield(who_obj);
+         end
+      end
+      tmp := rm_mult_objs_from_inven(who_obj, item, removed_qty);
+      destroy_object(item);
+   end
+end
+
+procedure remove_item_obj(variable who_obj, variable item) begin
+   if (obj_type(who_obj) == 1) then begin
+      if (critter_inven_obj(who_obj,INVEN_TYPE_WORN) == item) then begin
+         call unwield_armor(who_obj);
+      end else if ((critter_inven_obj(who_obj, INVEN_TYPE_LEFT_HAND) == item) or (critter_inven_obj(who_obj, INVEN_TYPE_RIGHT_HAND) == item)) then begin
+         inven_unwield(who_obj);
+      end
+   end
+   rm_obj_from_inven(who_obj, item);
+   destroy_object(item);
+end
+
+// aliases:
+#define remove_item_pid(obj, pid)            remove_items_pid(obj, pid, 1)
+#define remove_all_items_pid(obj, pid)       remove_items_pid(obj, pid, -1)
+
+/**
+ Set item quantity in inventory, by item pid
+ */
+procedure set_items_qty_pid(variable invenobj, variable itempid, variable newcount)
+begin
+   variable begin
+      count;
+      obj;
+   end
+   count := obj_is_carrying_obj_pid(invenobj, itempid);
+   if (newcount > count) then begin
+      obj := create_object_sid(itempid, 0, 0, -1);
+      add_mult_objs_to_inven(invenobj, obj, newcount - count);
+   end else if (newcount < count) then begin
+      call remove_items_pid(invenobj, itempid, count - newcount);
+   end
+end
+
+/*
+
+procedure check_restock_item(the_item, min_amt, max_amt, res_perc)
+      restock_amt := random(min_amt, max_amt);
+      if (obj_is_carrying_obj_pid(self_obj, the_item) < restock_amt) then begin
+         if (res_perc >= random(1,100)) then begin
+            stock_pid_qty(self_obj, the_item, restock_amt)
+         end
+      end else begin
+         stock_pid_qty(self_obj, the_item, restock_amt)
+      end
+procedure check_restock_item_min_limit(the_item, min_amt, max_amt, res_perc)
+      if (obj_is_carrying_obj_pid(self_obj, the_item) < min_amt) then begin
+         check_restock_item(the_item, min_amt, max_amt, res_perc)
+      end
+*/
+
+
+procedure reduce_merchant_loot(variable critter, variable moneyPercent, variable probArmor, variable probDrugs, variable probWeapons, variable probAmmo, variable probMisc) begin
+   variable inv, item, it, prob, tmp;
+   inv := inven_as_array(critter);
+   item_caps_adjust(critter, -(item_caps_total(critter) * moneyPercent / 100));
+   //display_msg("total items "+len_array(inv));
+   foreach item in inv begin
+      if (obj_pid(item) != PID_BOTTLE_CAPS) then begin
+         it := obj_item_subtype(item);
+         if (it == item_type_armor) then
+            prob := probArmor;
+         else if (it == item_type_drug) then
+            prob := probDrugs;
+         else if (it == item_type_weapon) then
+            prob := probWeapons;
+         else if (it == item_type_ammo) then
+            prob := probAmmo;
+         else
+            prob := probMisc;
+         if (random(0, 99) < prob) then begin
+            //display_msg("remove "+obj_name(item));
+            call remove_all_items_pid(critter, obj_pid(item));
+         end
+      end
+   end
+end
+
+procedure item_by_attack_type(variable critter, variable type) begin
+   variable slot;
+   if (type > 3 and type != ATKTYPE_LWEP_RELOAD and type != ATKTYPE_RWEP_RELOAD) then
+      return 0;
+   if (type < 2 or type == ATKTYPE_LWEP_RELOAD) then
+      slot := INVEN_TYPE_LEFT_HAND;
+   else
+      slot := INVEN_TYPE_RIGHT_HAND;
+   return critter_inven_obj(critter, slot);
+end
+
+#endif
@@ -0,0 +1,47 @@
+#ifndef LIB_MATH_H
+#define LIB_MATH_H
+
+/**
+  Numbers...
+*/
+
+#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)
+
+procedure max(variable x, variable y) begin
+   if (x > y) then return x;
+   return y;
+end
+
+procedure min(variable x, variable y) begin
+   if (x < y) then return x;
+   return y;
+end
+
+/*procedure round(variable val) begin
+   variable intp;
+   intp := floor(val);
+   if ((val-intp) >= 0.5) then intp++;
+   return intp;
+end*/
+
+procedure ceil(variable val) begin
+   variable intp;
+   intp := floor(val);
+   if (abs(val-intp) > 0.0) then begin
+      intp++;
+   end
+   return intp;
+end
+
+
+procedure cap_number(variable num, variable min, variable max) begin
+   if (num > max) then num := max;
+   else if (num < min) then num := min;
+   return num;
+end
+
+
+
+#endif
@@ -0,0 +1,85 @@
+#ifndef LIB_MISC_H
+#define LIB_MISC_H
+
+/**
+  Some generic procedures
+*/
+/*
+procedure round(variable val) begin
+   variable intp;
+   intp := floor(val);
+   if ((val-intp) >= 0.5) then intp++;
+   return intp;
+end*/
+
+// this fixes strange behavior when using negative float values
+// looks like the only way to create correct negative float is to use atof()
+// DEPRECATED as of sfall 3.4 (engine bug fixed)
+/*procedure itof_safe(variable var) begin
+   if (var < 0) then begin
+      var := atof("-"+(-var));
+   end
+   return var;
+end*/
+
+// Parse keyboard shortcut definition
+procedure parse_hotkey(variable string) begin
+   variable lst;
+   variable n;
+   lst := string_split(string, "+");
+   if (len_array(lst) == 0) then
+      return 0;
+   n := atoi(lst[0]);
+   if (len_array(lst) > 1) then
+      n += atoi(lst[1])*0x10000;
+   return n;
+end
+
+// Check if shortcut is pressed
+procedure hotkey_pressed(variable n) begin
+   if (n < 0x10000) then
+      return key_pressed(n);
+   else
+      return key_pressed(n bwand 0xFFFF) and key_pressed((n bwand 0xFFFF0000) / 0x10000);
+end
+
+// same as above, but suited for hs_keypress hook when keycode is already known
+procedure hotkey_pressed_now(variable n, variable key) begin
+   if (n < 0x10000) then
+      return key == n;
+   else begin
+      variable k1 := (n bwand 0xFFFF),
+               k2 := ((n bwand 0xFFFF0000) / 0x10000);
+      if (k1 == key) then begin
+         if (key_pressed(k2)) then return true;
+      end else if (k2 == key) then begin
+         if (key_pressed(k1)) then return true;
+      end
+      return false;
+   end
+end
+
+
+
+/**
+  Attempt to make list_as_array safe
+*/
+/*procedure list_as_array_safe(variable type) begin
+   variable list, item, arr, i;
+   list := list_begin(type);
+   arr := temp_array(100, 4);
+   i := 0;
+   item := list_next(list);
+   while (item) do begin
+      if (len_array(arr) == i) then resize_array(arr, len_array(arr) + 100);
+      arr[i] := item;
+      item := list_next(list);
+      i++;
+   end
+   resize_array(arr, i);
+   list_end(list);
+   return arr;
+end*/
+
+
+#endif
@@ -0,0 +1,243 @@
+/**
+
+  This library contains procedures to work with strings.
+
+  @author phobos2077
+
+*/
+
+#ifndef LIB_STRINGS_H
+#define LIB_STRINGS_H
+
+#define is_in_string(str, substr)         (string_pos(str, substr) != -1)
+#define string_starts_with(str, substr)   (string_pos(str, substr) == 0)
+
+/**
+ * Returns position of first occurance of substr in str, or -1 if not found
+ */
+procedure string_pos(variable str, variable subst) begin
+   variable lst, n;
+   lst := string_split(str, subst);
+   if (len_array(lst) < 2) then
+      return -1;
+   return strlen(lst[0]);
+end
+
+/**
+ * Join array of strings using delimeter
+ */
+procedure string_join(variable array, variable join) begin
+   variable str, i, len;
+   str := "";
+   len := len_array(array);
+   if (len > 0) then begin
+      str := array[0];
+      for (i:=1; i<len; i++) begin
+         str += join + array[i];
+      end
+   end
+   return str;
+end
+
+/**
+ * replaces all occurances of substring in a string with another substring
+ */
+#define string_replace(str, search, replace)    (string_join(string_split(str, search), replace))
+
+/**
+ * sprintf with two arguments
+ */
+procedure sprintf2(variable str, variable arg1, variable arg2) begin
+   variable split, len, i, j, arg;
+   split := string_split(str, "%");
+   len := len_array(split);
+   str := "";
+   if (len > 0) then begin
+      str := split[0];
+      j := 0;
+      for (i := 1; i < len; i++) begin
+         if (split[i] == "") then begin
+            if (i < len - 1) then begin
+               str += "%" + split[i+1];
+               i++;
+            end
+         end else begin
+            if (j == 0) then
+               arg := arg1;
+            else if (j == 1) then
+               arg := arg2;
+            else
+               arg := 0;
+
+            str += sprintf("%" + split[i], arg);
+            j++;
+         end
+      end
+   end
+   return str;
+end
+
+/**
+ * sprintf with unlimited number of arguments
+ */
+procedure sprintf_array(variable str, variable args) begin
+   variable split, len, i, j;
+   split := string_split(str, "%");
+   len := len_array(split);
+   str := "";
+   if (len > 0) then begin
+      str := split[0];
+      j := 0;
+      for (i := 1; i < len; i++) begin
+         if (split[i] == "") then begin
+            if (i < len - 1) then begin
+               str += "%" + split[i+1];
+               i++;
+            end
+         end else begin
+            str += sprintf("%" + split[i], args[j]);
+            j++;
+         end
+      end
+   end
+   return str;
+end
+
+/**
+ * Returns position of last occurance of substr in str, or -1 if not found
+ */
+/*procedure string_rpos(variable str, variable substr) begin
+variable lst, n;
+   lst := string_split(str, substr);
+   n := len_array(lst);
+   if (n < 2) then
+      return -1;
+   return string_len(str) - (string_len(lst[n-1]) + string_len(substr));
+end*/
+
+/**
+ * Basically the same as string_split, but delim is of type char instead of string
+ */
+procedure string_get_tokens(variable str, variable delim) begin
+   variable lst, line, token, maxlen, len, count;
+   count := 1;
+   maxlen := 4;
+   token := tokenize(str, 0, delim);
+   //if (token != 0) then
+      //count := 1;
+      line := token;
+      while (line != str) do begin
+         count += 1;
+         len := strlen(token);
+         if (len > maxlen) then
+            maxlen := len;
+         token := tokenize(str, line, delim);
+         if (token != 0) then
+            line += delim + token;
+      end
+   //end
+
+   return count;
+end
+
+procedure string_repeat(variable str, variable count) begin
+   variable out := "", i := 0;
+   while (i < count) do begin
+      out += str;
+      i++;
+   end
+   return out;
+end
+
+/**
+ * Workaround for string_split bug in sfall 3.3
+ * DEPRECATED as of sfall 3.4 (bug fixed)
+ */
+procedure string_split_safe(variable str, variable split) begin
+   variable lst;
+   str += split;
+   lst := string_split(str, split);
+   resize_array(lst, len_array(lst) - 1);
+   return lst;
+end
+
+/**
+ * The same as sfall string_split, but returns array of integers instead
+ * Useful in cunjunction with is_in_array()
+ */
+procedure string_split_ints(variable str, variable split) begin
+   variable i := 0;
+   variable list;
+   list := string_split(str, split);
+   while (i < len_array(list)) do begin
+      list[i] := atoi(list[i]);
+      i++;
+   end
+   return list;
+end
+
+
+/**
+  String parse functions. Idea taken from KLIMaka on TeamX forums.
+  Placeholders in format %d% are replaced from string. d refers to variable index (starting from 1).
+  You can repeat one placeholder multiple times, or use placeholders in any order.
+
+  Example:
+  parse_str_2("Hello, %2%. I have only $%1% to spare.", money_amount, dude_name);
+  Will return:
+  Hello, Killiano. I have only $1200 to spare.
+
+  The *_list function takes a temp_array as second parameter.
+*/
+
+#define _TOKENIZE_BEGIN       \
+   variable token, rest, line, result, n; \
+   line := tokenize(str, 0, '%'); \
+   result := line; \
+   while line != str do begin \
+      token := tokenize(str, line, '%'); \
+      line += "%" + token; \
+      if token == "" then result += "%"; \
+      else begin
+
+#define _TOKENIZE_END       \
+      end \
+      rest := tokenize(str, line, '%'); \
+      if (rest != 0) then begin \
+         line += "%" + rest; \
+         result += rest; \
+      end \
+   end \
+   return result;
+
+
+procedure parse_str_list(variable str, variable list) begin
+_TOKENIZE_BEGIN
+      n := atoi(token) - 1;
+      if (n >= 0 and n < len_array(list)) then result += list[n];
+_TOKENIZE_END
+end
+
+procedure parse_str_2(variable str, variable x1, variable x2) begin
+_TOKENIZE_BEGIN
+      n := atoi(token);
+      if (n == 1) then result += x1;
+      else if (n == 2) then result += x2;
+_TOKENIZE_END
+end
+
+procedure parse_str_4(variable str, variable x1, variable x2, variable x3, variable x4) begin
+_TOKENIZE_BEGIN
+      n := atoi(token);
+      if (n == 1) then result += x1;
+      else if (n == 2) then result += x2;
+      else if (n == 3) then result += x3;
+      else if (n == 4) then result += x4;
+_TOKENIZE_END
+end
+
+#undef _TOKENIZE_BEGIN
+#undef _TOKENIZE_END
+
+#endif
+
@@ -16,32 +16,32 @@
 #define SKILLDEX   (0x4000)

 //Valid arguments to register_hook
-#define HOOK_TOHIT           (0)
-#define HOOK_AFTERHITROLL    (1)
-#define HOOK_CALCAPCOST      (2)
-#define HOOK_DEATHANIM1      (3)
-#define HOOK_DEATHANIM2      (4)
-#define HOOK_COMBATDAMAGE    (5)
-#define HOOK_ONDEATH         (6)
-#define HOOK_FINDTARGET      (7)
-#define HOOK_USEOBJON        (8)
-#define HOOK_REMOVEINVENOBJ  (9)
-#define HOOK_BARTERPRICE     (10)
-#define HOOK_MOVECOST        (11)
-#define HOOK_HEXMOVEBLOCKING (12)
-#define HOOK_HEXAIBLOCKING   (13)
+#define HOOK_TOHIT            (0)
+#define HOOK_AFTERHITROLL     (1)
+#define HOOK_CALCAPCOST       (2)
+#define HOOK_DEATHANIM1       (3)
+#define HOOK_DEATHANIM2       (4)
+#define HOOK_COMBATDAMAGE     (5)
+#define HOOK_ONDEATH          (6)
+#define HOOK_FINDTARGET       (7)
+#define HOOK_USEOBJON         (8)
+#define HOOK_REMOVEINVENOBJ   (9)
+#define HOOK_BARTERPRICE      (10)
+#define HOOK_MOVECOST         (11)
+#define HOOK_HEXMOVEBLOCKING  (12)
+#define HOOK_HEXAIBLOCKING    (13)
 #define HOOK_HEXSHOOTBLOCKING (14)
 #define HOOK_HEXSIGHTBLOCKING (15)
-#define HOOK_ITEMDAMAGE      (16)
-#define HOOK_AMMOCOST        (17)
-#define HOOK_USEOBJ          (18)
-#define HOOK_KEYPRESS        (19)
-#define HOOK_MOUSECLICK      (20)
-#define HOOK_USESKILL        (21)
-#define HOOK_STEAL           (22)
+#define HOOK_ITEMDAMAGE       (16)
+#define HOOK_AMMOCOST         (17)
+#define HOOK_USEOBJ           (18)
+#define HOOK_KEYPRESS         (19)
+#define HOOK_MOUSECLICK       (20)
+#define HOOK_USESKILL         (21)
+#define HOOK_STEAL            (22)
 #define HOOK_WITHINPERCEPTION (23)
 #define HOOK_INVENTORYMOVE    (24)
-#define HOOK_INVENWIELD      (25)
+#define HOOK_INVENWIELD       (25)

 //Valid arguments to list_begin
 #define LIST_CRITTERS    (0)
@@ -187,3 +187,12 @@

 #define party_member_list_critters      party_member_list(0)
 #define party_member_list_all           party_member_list(1)
+
+
+#define critter_inven_obj2(obj, type)         sfall_func2("critter_inven_obj2", obj, type)
+#define exec_map_update_scripts               sfall_func0("exec_map_update_scripts")
+#define intface_hide                          sfall_func0("intface_hide")
+#define intface_is_hidden                     sfall_func0("intface_is_hidden")
+#define intface_redraw                        sfall_func0("intface_redraw")
+#define intface_show                          sfall_func0("intface_show")
+#define spatial_radius(obj)                   sfall_func1("spatial_radius", obj)
@@ -6,29 +6,48 @@ Hook scripts are specially named scripts that are run by sfall at specific point

 In addition to the bit of code it overrides, the script will be run once when first loaded and again at each player reload to allow for setup. Hook scripts have access to a set of arguments supplied to sfall, but aren't required to use them all. They also return one or more values, but again they're optional, and you only need to return a value if you want to override the default.

-As good practise to aid in mod compatibility, only use the hs_xxx .int script if you are setting return values. For any other scripts, use a normal global script combined with register_hook or register_hook_proc.
+To aid in mods compatibility, avoid using hs_xxx .int scripts. Instead it is recommended to use a normal global script combined with register_hook_proc or register_hook.

-There are script functions specific to hook scripts:
+Example setup for a hook-script based mod:

-int init_hook()
+
+
+procedure tohit_hook_handler begin
+   display_msg("Modifying hit_hook " + get_sfall_arg);
+   set_hit_chance_max(100);
+   set_sfall_return(100);
+end
+
+procedure start begin
+   if game_loaded then begin
+      register_hook_proc(HOOK_TOHIT, tohit_hook_handler);
+   end
+end
+
+
+
+
+There are script functions available, specific to hook scripts:
+
+> int init_hook()
 The hook script equivilent of game_loaded; it returns 2 when the script is first loaded, 1 when the player reloads and 0 otherwise.

-mixed get_sfall_arg()
+> mixed get_sfall_arg()
 Gets the next argument from sfall. Each time it's called it returns the next argument, or otherwise it returns 0 if there are no more arguments left.

-int get_sfall_args()
+> array get_sfall_args()
 Returns all hook arguments as a new temp array.

-void set_sfall_return(int value)
+> void set_sfall_return(int value)
 Used to return the new values from the script. Each time it's called it sets the next value, or if you've already set all return values it does nothing.

-void set_sfall_arg(int argnum, int value)
-Changes argument value. This is usefull if you have several hook scripts attached to one hook point (see below).
+> void set_sfall_arg(int argnum, int value)
+Changes argument value. The argument number (argnum) is 0-indexed. This is usefull if you have several hook scripts attached to one hook point (see below).

-void register_hook(int hooktype)
+> void register_hook(int hooktype)
 Used from a normal global script if you want to run it at the same point a full hook script would normally run. In case of this function, "start" proc will be execuded in a current global script. You can use all above functions like normal.

-void register_hook_proc(int hooktype, proc procedure)
+> void register_hook_proc(int hooktype, proc procedure)
 The same as register_hook, except that you specifically define which procedure in the current script should be called as a hook (instead of "start"). Pass procedure the same as how you use dialog option functions. This IS the recommended way to use hook scripts, as it gives both modularity (each mod logic in a separate global script, no conflicts if you don't use "hs_*.int" scripts) and flexibility (you can place all related hook scripts for specific mod in a single script!).

 NOTE: you can hook several scripts to a single hook point, for example if it's different mods from different authors or just some different aspects of one larger mod. In this case scripts are executed in reverse order of how they were registered. When one of the scripts in a chain returns value with "set_sfall_return", the next script may override this value if calls "set_sfall_return" again. Sometimes you need to multiply certain value in a chain of hook scripts.
@@ -39,13 +58,13 @@ Example: let's say we have a Mod A which reduces all "to hit" chances by 50%. Th

 Mod B also want to affect hit chances globally, by increasing them by 50%. Now in order for both mods to work well together, we need to add this line to Mod A hook script:

-    set_sfall_arg(original_chance / 2);
+    set_sfall_arg(0, (original_chance / 2));

 This basically changes hook argument for the next script. Mod B code:

    original_chance = get_sfall_arg;
    set_sfall_return(original_chance * 1.5);
-    set_sfall_arg(original_chance * 1.5);
+    set_sfall_arg(0, (original_chance * 1.5));

 So if you combine both mods together, they will run in chain and the end result will be a 75% from original hit chance (hook register order doesn't matter in this case, if you use "set_sfall_arg" in both hooks).

@@ -56,7 +75,7 @@ The defines to use for the hooktype are in sfall.h.
 ----------- HOOK SCRIPT TYPES -------------
 -------------------------------------------

-hs_tohit.int
+HOOK_TOHIT (hs_tohit.int)

 Runs when fallout is calculating the chances of an attack striking a target
 Runs after the hit chance is fully calculated normally, including applying the 95% cap
@@ -65,12 +84,15 @@ int     arg1 - The unmodified hit chance
 critter arg2 - The attacker
 critter arg3 - The target of the attack
 int     arg4 - The targeted bodypart
+int     arg5 - Source tile (may differ from attacker's tile, when AI is considering potential fire position)
+int     arg6 - Attack Type (one of ATKTYPE_*)
+int     arg7 - Ranged flag (0 or 1, actually passed 1 even for unarmed attacks, may be a vanilla bug)

 int     ret1 - the new hit chance

 -------------------------------------------

-hs_afterhitroll.int
+HOOK_AFTERHITROLL (hs_afterhitroll.int)

 Runs after fallout has decided if an attack will hit or miss

@@ -86,7 +108,7 @@ critter ret3 - Override the target of the attack

 -------------------------------------------

-hs_calcapcost.int
+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 players hands at the time the wrong ap cost will be shown. It will be fixed the next time the interface is redrawn.
@@ -101,7 +123,7 @@ int     ret1 - The new ap cost

 -------------------------------------------

-hs_deathanim1.int
+HOOK_DEATHANIM1 (hs_deathanim1.int)

 Runs before fallout tries to calculate the death animation. Lets you switch out which weapon fallout sees

@@ -114,7 +136,7 @@ int     ret1 - The pid of an object to override the attacking weapon with

 -------------------------------------------

-hs_deathanim2.int
+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 hs_deathanim1, but performs no validation.
 When using critter_dmg function, this script will also run. In that case weapon pid will be -1 and target will point to an object with obj_art_fid == 0x20001F5.
@@ -129,7 +151,7 @@ int     ret1 - The death anim id to override with

 -------------------------------------------

-hs_combatdamage.int
+HOOK_COMBATDAMAGE (hs_combatdamage.int)

 Runs when:
 1) Game calculates how much damage each target will get. This includes primary target as well as all extras (explosions and bursts). This happens BEFORE the actual attack animation.
@@ -144,9 +166,10 @@ int     arg5  - The special effect flags for the target
 int     arg6  - The special effect flags for the attacker
 int     arg7  - The weapon used in the attack
 int     arg8  - The bodypart that was struck
-int     arg9  - Roll result of the attack (check with is_success, etc functions; basically: 0-crit. fail, 1-fail, 2-success, 3-crit. success)
+int     arg9  - Damage Multipiler (this is divided by 2, so a value of 3 does 1.5x damage, and 8 does 4x damage. Usually it's 2, but with Silent Death perk and the corresponding attack conditions, it's 4; for critical hits, the value is taken from the critical table)
 int     arg10 - Number of bullets actually hit the target (1 for melee attacks)
 int     arg11 - The amount of knockback to the target
+int     arg12 - Attack Type (see ATKTYPE_* constants)

 int     ret1 - The damage to the target
 int     ret2 - The damage to the attacker
@@ -156,7 +179,7 @@ int     ret5 - The amount of knockback to the target

 -------------------------------------------

-hs_ondeath.int
+HOOK_ONDEATH (hs_ondeath.int)

 Runs immediately after a critter dies for any reason. No return values; this is just a convinence for when you need to do something after death for a large number of different critters and don't want to have to script each and every one of them.

@@ -164,7 +187,7 @@ Critter arg1 - The critter that just died

 -------------------------------------------

-hs_findtarget.int
+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. This hook replaces that sorting function, allowing you to sort the targets in some arbitrary way. Use sfall_return to give the 4 targets, in order of preference. All 4 must be given if you want to override normal sorting; if you want to specify less than 4 targets fill in the extra spaces with 0's. If you do not give 4 targets, the npcs normal sorting mechanism will be used.

@@ -183,7 +206,7 @@ critter ret4 - The fourth choice of target

 -------------------------------------------

-hs_useobjon.int
+HOOK_USEOBJON (hs_useobjon.int)

 Runs when:
 1) a critter uses an object on another critter. (Or themselves)
@@ -201,7 +224,7 @@ int     ret1 - overrides hard-coded handler and selects what should happen with

 -------------------------------------------

-hs_useobj.int
+HOOK_USEOBJ (hs_useobj.int)

 Runs when:
 1) a critter uses an object from inventory which have "Use" action flag set or it's an active flare or dynamite.
@@ -217,7 +240,7 @@ int     ret1 - overrides hard-coded handler and selects what should happen with

 -------------------------------------------

-hs_removeinvenobj.int
+HOOK_REMOVEINVENOBJ (hs_removeinvenobj.int)

 Runs when an object is removed from a critters inventory for any reason

@@ -228,22 +251,25 @@ int     arg4 - The reason the object is being removed. (Actually, the site from

 -------------------------------------------

-hs_barterprice.int
+HOOK_BARTERPRICE (hs_barterprice.int)

 Runs whenever the value of goods being purchased is calculated

 critter arg1 - the critter doing the bartering (either dude_obj or inven_dude)
 critter arg2 - the critter being bartered with
 int     arg3 - the default value of the goods
-critter arg4 - the barter critter (has all of the goods being traded in its inventory)
+critter arg4 - table of requested goods (being bought from NPC)
 int     arg5 - the amount of actual caps in the barter stack (as opposed to goods)
 int     arg6 - the value of all goods being traded before skill modifications
+critter arg7 - table of offered goods (being sold to NPC)
+int     arg8 - the total cost of the goods offered by the player
+int     arg9 - set 1 if the "offers" button was pressed (not for a party member), otherwise 0

 int     ret1 - the modified value of all of the goods

 -------------------------------------------

-hs_movecost.int
+HOOK_MOVECOST (hs_movecost.int)

 Runs when calculating the ap cost of movement

@@ -277,7 +303,7 @@ object* ret1 - 0 if the hex doesn't block, or any sort of object pointer if it d

 -------------------------------------------

-hs_itemdamage.int
+HOOK_ITEMDAMAGE (hs_itemdamage.int)

 Runs when retriving the damage rating of the players used weapon. (Which may be their fists.)

@@ -293,7 +319,7 @@ int     ret2 - The new maximum damage

 -------------------------------------------

-hs_ammocost.int
+HOOK_AMMOCOST (hs_ammocost.int)

 Runs when calculating ammo cost for a weapon. Doesn't affect damage, only how much ammo is spent.
 By default, weapon will shoot when at least 1 round is left, regardless of ammo cost calculations.
@@ -309,7 +335,7 @@ int     ret1 - new ammo cost value (set to 0 for unlimited ammo)

 -------------------------------------------

-hs_keypress.int
+HOOK_KEYPRESS (hs_keypress.int)

 Runs once every time when any key was pressed or released.
 DX codes: (see dik.h header)
@@ -321,7 +347,7 @@ int     arg3 - key VK code (very similar to ASCII codes)

 -------------------------------------------

-hs_mouseclick.int
+HOOK_MOUSECLICK (hs_mouseclick.int)

 Runs once every time when a mouse button was pressed or release.

@@ -330,7 +356,7 @@ int     arg2 - button number (0 - left, 1 - right, up to 7)

 -------------------------------------------

-hs_useskill.int
+HOOK_USESKILL (hs_useskill.int)

 Runs when using any skill on any object.

@@ -347,7 +373,7 @@ int     ret1 - overrides hard-coded handler (-1 - use engine handler, any other

 -------------------------------------------

-hs_steal.int
+HOOK_STEAL (hs_steal.int)

 Runs when checking an attempt to steal or plant an item in other inventory using Steal skill.

@@ -363,7 +389,7 @@ int     ret1 - overrides hard-coded handler (1 - force success, 0 - force fail,

 -------------------------------------------

-hs_withinperception.int
+HOOK_WITHINPERCEPTION (hs_withinperception.int)

 Runs when checking if one critter sees another critter. This is used in different situations like combat AI. You can override the result.

@@ -379,7 +405,7 @@ int     ret1 - overrides the returned result of the function: 0 - not in range (

 -------------------------------------------

-hs_inventorymove.int
+HOOK_INVENTORYMOVE (hs_inventorymove.int)

 Runs before moving items between inventory slots in dude interface. You can override the action.
 What you can NOT do with this hook:
@@ -390,7 +416,7 @@ What you can do:
 - add AP costs for all inventory movement including reloading
 - apply or remove some special scripted effects depending on PC's armor

-int     arg1 - Target slot (0 - main backback, 1 - left hand, 2 - right hand, 3 - armor slot, 4 - weapon, when reloading it by dropping ammo)
+int     arg1 - Target slot (0 - main backpack, 1 - left hand, 2 - right hand, 3 - armor slot, 4 - weapon, when reloading it by dropping ammo)
 Item    arg2 - Item being moved
 Item    arg3 - Item being replaced or weapon being reloaded (can be 0)

@@ -398,10 +424,12 @@ int     ret1 - Override setting (-1 - use engine handler, any other value - prev

 -------------------------------------------

-hs_invenwield.int
+HOOK_INVENWIELD (hs_invenwield.int)

 Runs before wielding or unwielding an armor or a weapon by a critter (except when using inventory by PC).
 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.
+If you need to rely on this, try checking if armor/weapon already equipped when wielding hook is executed.

 Critter arg1 - critter
 Obj     arg2 - item being wielded or unwielded (weapon/armor), may be 0 when unwielding
@@ -48,7 +48,7 @@ set_fake_trait and set_fake_perk can be used to add additional traits and perks

 has_fake_trait and has_fake_perk return the number of levels the player has of the perks/traits with the given name.

-perk_add_mode, set_selectable_perk, set_perkbox_title, hide_real_perks, show_real_perks and clear_selectable_perks control the behaviour of the select a perk box. set_selectable_perk can be used to add additional items by setting the 'active' parameter to 1, and to remove them again by setting it to 0.  set_perkbox_title can be used to change the title of the box, or by using "" it will be set back to the default. hide and show_real_perks can be used to prevent the dialog from displaying any of the original 119 perks. perk_add_mode modifies what happens when a fake perk is selected from the perks dialog. It is treated as a set of flags - if bit 1 is set then it is added to the players traits, if bit 2 is set it is added to the players perks, and if bit 3 is set it is removed from the list of selectable perks. The default is 0x2. clear_selectable_perks restores the dialog to it's default state.
+perk_add_mode, set_selectable_perk, set_perkbox_title, hide_real_perks, show_real_perks and clear_selectable_perks control the behaviour of the select a perk box. set_selectable_perk can be used to add additional items by setting the 'active' parameter to 1, and to remove them again by setting it to 0. set_perkbox_title can be used to change the title of the box, or by using "" it will be set back to the default. hide and show_real_perks can be used to prevent the dialog from displaying any of the original 119 perks. perk_add_mode modifies what happens when a fake perk is selected from the perks dialog. It is treated as a set of flags - if bit 1 is set then it is added to the players traits, if bit 2 is set it is added to the players perks, and if bit 3 is set it is removed from the list of selectable perks. The default is 0x2. clear_selectable_perks restores the dialog to it's default state.

 show_iface_tag, hide_iface_tag and is_iface_tag_active relate to the boxes that appear above the interface such as SNEAK and LEVEL. You can use 3 for LEVEL and 4 for ADDICT, or the range from 5 to 9 for custom boxes. Remember to add your messages to intrface.msg and setup the font colours in ddraw.ini if you're going to use custom boxes.

@@ -62,7 +62,7 @@ nb_* functions are reserved for the brotherhood tactical training mod, and shoul

 The fs_* functions are used to manipulate a virtual file system. Files saved here should have paths relative to the data folder, and use backslashes as the directory seperator. They will take precedence over files stored in the normal data folder. They will also be saved into save games, so be avoid creating large files. Using fs_copy followed by fs_read_xxx, you can read the contents of existing files.

-get/set_proto_data are used to manipulate the in memory copies of the .pro files fallout makes when they are loaded. The offset refers to the offset in memory from the start of the proto to the element you are reading, and is equal to the file offset minus 12. Changes are not stored on disc, and are not permenent. If you modify the protos, and then fallout subsequently reloads the file your changes will be lost.
+get/set_proto_data are used to manipulate the in memory copies of the .pro files fallout makes when they are loaded. The offset refers to the offset in memory from the start of the proto to the element you are reading. Changes are not stored on disc, and are not permenent. If you modify the protos, and then fallout subsequently reloads the file your changes will be lost.

 the list_xxx functions can be used to loop over all items on a map. list_begin takes an argument telling sfall what you want to list. (Defined in sfall.h) It returns a list pointer, which you iterate through with list_next. Finally, when you've finished with the list use list_end on it. Not calling list_end will result in a memory leak. Alternatively, use list_as_array to get the whole list at once as a temp array variable, which can be looped over using len_array and which you don't need to remember to free afterwards.

@@ -77,48 +77,67 @@ force_aimed_shots and disable_aimed_shots allow overriding the normal rules rega
 get/set_critter_skill_points will get/set the number of additional points a critter has in a skill, on top of whatever they have from their stats and other bonuses. Note that skill points are part of the proto, so calling set_skill_points on a critter will affect all critters that share the same proto.


+
+------------------------------
+------ TYPES REFERENCE -------
+------------------------------
+
+> Data types mentioned in this document:
+
+void - means opcode does not return any value
+any - any type
+int - integer number
+float - floating point number
+string - string (text) value
+object - pointer to game object (actually an integer)
+array - array ID to be used with array-related functions (actually an integer)
+
+
 ----------------------------------------------
 ------ FUNCTION REFERENCE (incomplete) -------
 ----------------------------------------------

-> int game_loaded() 
+> int game_loaded()
 - returns 1 the first time it is called after a new game or game load, and 0 any time after. It works on an individual basis for each script, so one script wont interfere with others. It's primary use is for global scripts, so that they know when to call set_global_script_repeat, but it can be called from normal scripts too.

-> void inc_npc_level(string npc) 
- takes an npc name as an argument. The npc must be in your party. This function ignores player level requirements and the minimum 3 player level delay between npc level gains. It also ignores the random element, regardless of sfall's NPCAutoLevel setting. 
+> void inc_npc_level(string npc)
+- takes an npc name as an argument. The npc must be in your party. This function ignores player level requirements and the minimum 3 player level delay between npc level gains. It also ignores the random element, regardless of sfall's NPCAutoLevel setting.

 > int get_npc_level(string npc)
 - also takes the npc name as an argument, and returns the npc's current level. Again, the npc needs to be in your party.

-> int   get_ini_setting(string setting)
- reads an integer value from an ini file in the fallout directory. 
- It only takes a single argument; seperate the file name, section and key with a '|' character; e.g. 'myvar:=get_ini_setting("myini.ini|mysec|var1")' If the file or key cannot be found, -1 is returned. 
- The file name is limited to 16 chars, including the extension. 
- The section name is limited to 8 characters. 
+> void set_car_current_town(int town)
+- changes the current town index for the player's car
+
+> int get_ini_setting(string setting)
+- reads an integer value from an ini file in the fallout directory.
+- It only takes a single argument; seperate the file name, section and key with a '|' character; e.g. 'myvar:=get_ini_setting("myini.ini|mysec|var1")' If the file or key cannot be found, -1 is returned.
+- The file name is limited to 16 chars, including the extension.
+- The section name is limited to 8 characters.
 - It can also be used to get sfalls settings, by using ddraw.ini as the file name.

 > string get_ini_string(string setting)
- reads a string value from an ini file in the fallout directory. 
+- reads a string value from an ini file in the fallout directory.

 > int get_game_mode()
- is a more flexible version of in_world_map. It will return a set of flags indicating which mode the game is currently in. 
+- is a more flexible version of in_world_map. It will return a set of flags indicating which mode the game is currently in.
 - These flags are the same as those used in the set_shader_mode function.

 > int get_uptime()
 - is just a wrapper around the windows GetTickCount() function. It's useful for making time fade effects in shaders, since they already have access to the current tick count.

-> boolean in_world_map() 
- returns 1 if the player is looking at the world map, or 0 at any other time. 
+> boolean in_world_map()
+- returns 1 if the player is looking at the world map, or 0 at any other time.
 - Obviously this is only useful in global scripts, since normal scripts will never get the chance to run on the world map.

-> void force_encounter(int map) 
- can be called either from a global script while traveling on the world map, or from a normal script while on a local map. 
+> void force_encounter(int map)
+- can be called either from a global script while traveling on the world map, or from a normal script while on a local map.
 - In either case the encounter occurs shortly after the next time the player moves on the world map.
 - The player will not get an outdoorsman skill check.

 > void force_encounter_with_flags(int map, int flags)
- does the same thing as force_encounter, but allows the specification of some extra options. 
- Forcing a random encounter on a map that is not normally used for random encounters may cause the player to lose the car, if they have it. 
+- does the same thing as force_encounter, but allows the specification of some extra options.
+- Forcing a random encounter on a map that is not normally used for random encounters may cause the player to lose the car, if they have it.
 - In this case use force_encounter_with_flags with the ENCOUNTER_FLAG_NO_CAR flag set.

 > int get_light_level()
@@ -129,40 +148,40 @@ get/set_critter_skill_points will get/set the number of additional points a crit
 - adjusts how fast time passes while you're on the world map. It takes a single float as an argument, where 1 is the normal speed.
 - This function works in addition to the WorldMapTimeMod setting in ddraw.ini and the pathfinder perk, rather than overriding it, so calling set_map_time_multi(0.5) when the player has 2 levels of pathfinder would result in time passing at 25% the normal speed on the world map.

-> void remove_script(objptr)
- accepts a pointer to an object and will remove the script from that object. 
+> void remove_script(object)
+- accepts a pointer to an object and will remove the script from that object.

-> void set_script(objptr, int scriptid)
+> void set_script(object, int scriptid)
 - accepts a pointer to an object and scriptID, and applies the given script to an object (scriptID accept the same values as create_object_sid from sfall 3.6)
 - If used on an object that is already scripted, it will remove the existing script first; you cannot have multiple scripts attached to a single object. Calling set_script on self_obj will have all sorts of wacky side effects, and should be avoided.
 - if you add 0x80000000 to the sid when calling set_script, map_enter_p_proc will be SKIPPED. The start proc will always be run.

-> int get_script(objptr)
- accepts a pointer to an object and returns it's scriptID (line number in scripts.lst), or -1 if the object is unscripted. 
+> int get_script(object)
+- accepts a pointer to an object and returns it's scriptID (line number in scripts.lst), or -1 if the object is unscripted.

-> void set_self(int obj) 
- overrides the scripts self_obj for the next function call. 
- It is primarily used to allow the calling of functions which take an implicit self_obj parameter (e.g. drop_obj) from global scripts, but it can also be used from normal scripts; 
+> void set_self(int obj)
+- overrides the scripts self_obj for the next function call.
+- It is primarily used to allow the calling of functions which take an implicit self_obj parameter (e.g. drop_obj) from global scripts, but it can also be used from normal scripts;
 - self_obj will revert back to its original value after the next function call.
 - calling self_obj(0) will also revert self_obj to original value
 - source_obj, target_obj, and similar functions will not work if preceeded by "set_self"

 > void mod_skill_points_per_level(int x)
- accepts a value of between -100 and 100, and modifies the number of skill points the player recieves when they level up. 
- This is a modification of what would otherwise happen, rather than a replacement. 
+- accepts a value of between -100 and 100, and modifies the number of skill points the player recieves when they level up.
+- This is a modification of what would otherwise happen, rather than a replacement.
 - The value is not saved into the save game, so should be reset in the game_loaded section of a script.

 > void seq_perk_freq(int x)
- sets the number of levels between each perk. 
- Setting 0 will reset it back to the default. 
- This overrides the effects of the skilled trait. 
- It is not saved into the save game, so needs to be called once per reload. 
+- sets the number of levels between each perk.
+- Setting 0 will reset it back to the default.
+- This overrides the effects of the skilled trait.
+- It is not saved into the save game, so needs to be called once per reload.
 - Be careful not to let the player obtain a perk when no perks are available to pick, or the game may crash.

-> ObjectPtr get_last_target(objptr) 
- will return the last critter to be deliberately attacked 
-> ObjectPtr get_last_attacker(objptr) 
- will return the last critter to deliberately launch an attack against the argument critter. 
+> object get_last_target(object)
+- will return the last critter to be deliberately attacked
+> object get_last_attacker(object)
+- will return the last critter to deliberately launch an attack against the argument critter.
 - If a critter has not launched/recieved an attack, it will return 0. This is only stored for the duration of combat, and outside of combat both functions will always return 0.

 > void set_base_pickpocket_mod(int max, int mod)
@@ -170,46 +189,46 @@ get/set_critter_skill_points will get/set the number of additional points a crit
 - "max" will replace 95% success chance cap (so you can set 100% maximum chance, for instance)
 - "mod" will add this much percent to each success chance. for example if your chance is 50% and "mod" is 20, you will get 70% actual success rate

-> void set_critter_pickpocket_mod(CritterPtr, int max, int mod)
+> void set_critter_pickpocket_mod(object, int max, int mod)
 - the same as above, but applies only to specific critter

-> void reg_anim_combat_check 
+> void reg_anim_combat_check
 - allows to enable all reg_anim_* functions in combat (including vanilla functions) if set to 0. It is automatically reset at the end of each frame, so you need to call it before "reg_anim_begin" - "reg_anim_end" block.

-  
-Some additional reg_anim_* functions were introduced. They all work in the same convention as vanilla functions and use the same underlying code. 

-> void reg_anim_destroy(object) 
+Some additional reg_anim_* functions were introduced. They all work in the same convention as vanilla functions and use the same underlying code.
+
+> void reg_anim_destroy(object)
 - given object is destroyed at the end of current animation set
-    
-> void reg_anim_animate_and_hide(object, animID, delay) 
+
+> void reg_anim_animate_and_hide(object, animID, delay)
 - exactly like "reg_anim_animate" but the object will automatically disappear after the last animation frame (but not destroyed)

-> void reg_anim_light(object, light, delay) 
+> void reg_anim_light(object, light, delay)
 - change light of any object. light argument is a light radius (0-8), but you can use highest 2 bytes to pass light intensity as well (example: 0xFFFF0008 - intensity 65535 and radius 8). If highest 2 bytes are 0, intensity will not be changed. Intensity range is from 0 to 65535 (0xFFFF).

-> void reg_anim_change_fid(object, fid, delay) 
+> void reg_anim_change_fid(object, fid, delay)
 - should work like art_change_fid_num but in reg_anim sequence

-> void reg_anim_take_out(object, holdFrameID, delay) 
+> void reg_anim_take_out(object, holdFrameID, delay)
 - plays "take out weapon" animation for given holdFrameID. It is not required to have such weapon in critter's inventory.
-    
-> void reg_anim_turn_towards(object, tile/target, delay) 
+
+> void reg_anim_turn_towards(object, tile/target, delay)
 - makes object change it's direction to face given tile num or target object.

 > int metarule2_explosions(int arg1, int arg2)
 was made as a dirty easy hack to allow dynamically change some explosion parameters (ranged attack). All changed parameters are reset to vanilla state automatically after each attack action. Following macros are available in sfall.h:

-> void set_attack_explosion_pattern(x, y) 
+> void set_attack_explosion_pattern(x, y)
 - currently y is not used and x means: 1 - reduced explosion pattern (3 effects are spawned instead of 7), 0 - full pattern

-> void set_attack_explosion_art(x, y) 
+> void set_attack_explosion_art(x, y)
 - y not used and x is a misc frame ID (last 3 bytes, without object type) to use for the next explosion.
-    
-> void set_attack_explosion_radius(x) 
+
+> void set_attack_explosion_radius(x)
 - changes radius at which explosion will hit secondary targets for the next attack (from the experiments it is limited to something around 8 by the engine)

-> void set_attack_is_explosion_fire 
+> void set_attack_is_explosion_fire
 - if you call this right before using a weapon with fire damage type, it will produce explosion effects (and radius damage) just like "explosion" type, but all targets will still recieve fire damage.


@@ -219,20 +238,20 @@ Some utility/math functions are available:
 - takes a string and a seperator, searches the string for all instances of the seperator, and returns a temp array filled with the pieces of the string split at each instance. If you give an empty string as the seperator, the string is split into individual characters.
 - you can use this to search for a substring in a string like this: strlen(get_array(string_split(haystack, needle), 0))

-> string substr(string, start, length) 
+> string substr(string, start, length)
 - cuts a substring from a string starting at "start" up to "length" characters. If start is negative - it indicates starting position from the end of the string (for example substr("test", -2, 2) will return last 2 charactes: "st"). If length is negative - it means so many characters will be omitted from the end of string (example: substr("test", 0, -2) will return string without last 2 characters: "te")

-> int strlen(char* string) 
+> int strlen(string string)
 - returns string length

-> string sprintf(char* format, any value) 
- formats given value using standart syntax of C printf function (google "printf" for format details). However it is limited to formatting only 1 value. 
+> string sprintf(string format, any value)
+- formats given value using standart syntax of C printf function (google "printf" for format details). However it is limited to formatting only 1 value.
 - can be used to get character by ASCII code ("%c")

-> int typeof(any value) 
+> int typeof(any value)
 - returns type of the given value: VALTYPE_INT, VALTYPE_FLOAT or VALTYPE_STR.

-> int charcode(char* string) 
+> int charcode(string string)
 - returns ASCII code for the first character in given string

 > ^ operator (exponentiation)
@@ -276,7 +295,8 @@ Some utility/math functions are available:

 > string message_str_game(int fileId, int messageId)
 - works exactly the same as message_str, except you get messages from files in "text/english/game" folder
- use GAME_MSG_* defines or  mstr_* macros from sfall.h to use specific msg file
+- use GAME_MSG_* defines or mstr_* macros from sfall.h to use specific msg file
+- Additional game msg files added by ExtraGameMsgFileList setting will have consecutive fileIds assigned beginning from 0x2000. (e.g. if you set ExtraGameMsgFileList=foo,bar in ddraw.ini, foo.msg will be associated with 0x2000 and bar.msg with 0x2001.)

 > int sneak_success
 - returns 1 if last sneak attempt (roll against skill) was successful, 0 otherwise
@@ -285,12 +305,12 @@ Some utility/math functions are available:
 > int tile_light(int elevation, int tileNum)
 - returns light intensity at the given tile in range from 0 to 65535

-> ObjectPtr obj_blocking_line(ObjectPtr objFrom, int tileTo, int blockingType)
+> object obj_blocking_line(object objFrom, int tileTo, int blockingType)
 - returns first object which blocks direct linear path from objFrom to tileTo using selected blocking function (see BLOCKING_TYPE_* constants in sfall.h)
 - if path is clear (no blocker was encountered by selected function) - returns 0
 - objFrom is always excluded from calculations, but is required to be a valid object

-> ObjectPtr obj_blocking_tile(int tileNum, int elevation, int blockingType)
+> object obj_blocking_tile(int tileNum, int elevation, int blockingType)
 - returns first object blocking given tile using given blocking function or 0 if tile is clear

 > array tile_get_objs(int tileNum, int elevation)
@@ -300,22 +320,58 @@ Some utility/math functions are available:
 > array party_member_list(int includeHidden)
 - returns array of all current party members (0 - only critter-type, alive and visible will be returned, 1 - all object, including Trunk, etc.)

-> array path_find_to(ObjectPtr objFrom, int tileTo, int blockingType)
+> array path_find_to(object objFrom, int tileTo, int blockingType)
 - returns the shortest path to a given tile using given blocking function as an array of tile directions (0..5) to move on each step
 - array length equals to a number of steps
 - empty array means that specified target cannot be reached

-> ObjectPtr create_spatial(int scriptID, int tile, int elevation, int radius)
+> object create_spatial(int scriptID, int tile, int elevation, int radius)
 - creates new spatial script with given SID, at given tile, and radius

 > int art_exists(int artFID)
 - checks if given artFID exists in the game
 - useful when you want to check if critter can use specific weapon: art_exists((artFid bwand 0xffff0fff) bwor (weaponAnim * 0x1000))

-> int obj_is_carrying_obj(ObjectPtr invenObj, ObjectPtr itemObj)
+> int obj_is_carrying_obj(object invenObj, object itemObj)
 - returns number of itemObj inside invenObj's inventory, note that both arguments are object pointers
 - useful when dealing with different stacks of same item (obj_is_carrying_obj_pid just returns total for all stacks of the same PID)

+> any sfall_funcX(string funcName, ...)
+- these opcodes allows to use additional scripting functions, that do not require new opcode
+- first argument is always function name (string)
+- there are 7 versions of this opcode for different number of additional arguments (for convenience)
+- opcodes have return value, but it is not neccessary to use it
+
+
+------------------------------------
+------ sfall_funcX functions -------
+------------------------------------
+
+> array sfall_func0("get_metarule_table")
+- returns names of all currently available scripting functions (via sfall_funcX)
+
+> int sfall_func1("spatial_radius", object object)
+- return radius of spatial script, associated with given dummy-object (returned by create_spatial)
+
+> object sfall_func2("critter_inven_obj2", object invenObj, int type)
+- works just like vanilla critter_inven_obj, but correctly reports item in player's inactive hand slot
+
+> void sfall_func0("intface_redraw")
+- redraws main game interface
+- useful after direct changes to current player weapons or stats to reflect changes
+
+> void sfall_func0("intface_hide")
+- hides main interface
+
+> void sfall_func0("intface_show")
+- shows main interface
+
+> int sfall_func0("intface_is_hidden")
+- returns 1 if interface is currently hidden, 0 otherwise
+
+> void sfall_func0("exec_map_update_scripts")
+- executes map_update_p_proc for all objects on map and global/hook scripts as well
+
 ------------------------
 ------ MORE INFO -------
 ------------------------
--- a/Show More
+++ b/Show More