update to 1.0.5-dev

CHANGELOG.md

@@ -1,4 +1,19 @@
-### 1.0.4
+### 1.0.5
+
+- add support for commands using global SCM variables (e.g. counters or timers).
+- delete previously deprecated variable `GAME`. Use `HOST` instead
+- update script watcher: changing `.mjs` files in a script directory or any nested directories triggers script reload
+- `FxtStore` can be forced to mutate global FXT keys by setting the last argument in `FxtStore.insert` and `FxtStore.delete` to true
+
+**SDK AND PLUGINS**
+- update IdeLoader to 1.2: fixed a parser bug that prevented `.ide` files with a `2dfx` section to be loaded
+- update Frontend to 1.1: reduce timeout during a check for updates to 10 seconds
+
+**BREAKING CHANGES**
+
+- bumped minimum required versions of [command definitions](https://re.cleo.li/docs/en/definitions.html)
+
+### 1.0.4 - November 22, 2022
 
 - experimental support for [async functions](https://re.cleo.li/docs/en/async.html)
 - add new method `CLEO.runScript` to [spawn new scripts](https://re.cleo.li/docs/en/api.html#cleorunscript)

docs/en/definitions.md

@@ -8,11 +8,11 @@ At start CLEO validates that a definition file is present and correct and if not
 | ----------------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------ |
 | GTA III, re3                        | [gta3.json](https://github.com/sannybuilder/library/blob/master/gta3/gta3.json)                      | `0.243`                  |
 | GTA VC, reVC                        | [vc.json](https://github.com/sannybuilder/library/blob/master/vc/vc.json)                            | `0.249`                  |
-| GTA San Andreas (Classic) 1.0       | [sa.json](https://github.com/sannybuilder/library/blob/master/sa/sa.json)                            | `0.287`                  |
-| GTA IV                              | [gta_iv.json](https://github.com/sannybuilder/library/blob/master/gta_iv/gta_iv.json)                | `0.45`                   |
+| GTA San Andreas (Classic) 1.0       | [sa.json](https://github.com/sannybuilder/library/blob/master/sa/sa.json)                            | `0.288`                  |
+| GTA IV                              | [gta_iv.json](https://github.com/sannybuilder/library/blob/master/gta_iv/gta_iv.json)                | `0.46`                   |
 | GTA III: The Definitive Edition     | [gta3_unreal.json](https://github.com/sannybuilder/library/blob/master/gta3_unreal/gta3_unreal.json) | `0.222`                  |
 | Vice City: The Definitive Edition   | [vc_unreal.json](https://github.com/sannybuilder/library/blob/master/vc_unreal/vc_unreal.json)       | `0.228`                  |
-| San Andreas: The Definitive Edition | [sa_unreal.json](https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json)       | `0.249`                  |
+| San Andreas: The Definitive Edition | [sa_unreal.json](https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json)       | `0.250`                  |
 | Bully: Scholarship Edition          | [bully.json](https://github.com/sannybuilder/library/blob/master/bully/bully.json)                   | `0.29`                   |
 | Unknown (32-bit)                    | [unknown_x86.json](https://github.com/sannybuilder/library/blob/master/unknown_x86/unknown_x86.json) | `0.216`                  |
 | Unknown (64-bit)                    | [unknown_x64.json](https://github.com/sannybuilder/library/blob/master/unknown_x64/unknown_x64.json) | `0.220`                  |

docs/en/using-fxt.md

@@ -31,7 +31,6 @@ Text.PrintHelp('KEY1') // displays <TEXT1>
 
 You can find the commands available in each game in the Sanny Builder Library, e.g. [for San Andreas: DE](https://library.sannybuilder.com/#/sa_unreal/classes/Text).
 
-
 > CLEO Redux only supports texts encoded in UTF-8. It means that any non-standard encoding (e.g. for Russian localization by 1C) most likely will not work.
 
 ## FxtStore
@@ -46,13 +45,15 @@ declare interface FxtStore {
    * Inserts new text content in the script's fxt storage overwriting the previous content and shadowing static fxt with the same key
    * @param key GXT key that can be used in text commands (7 characters max)
    * @param value text content
+   * @param [isGlobal] if true, the text affects global FXT storage
    */
-  insert(key: string, value: string): void;
+  insert(key: string, value: string, isGlobal?: boolean): void;
   /**
    * Removes the text content associated with the key in the local fxt storage
    * @param key GXT key
+   * @param [isGlobal] if true, the text affects global FXT storage
    */
-  delete(key: string): void;
+  delete(key: string, isGlobal?: boolean): void;
 }
 ```
 
@@ -74,7 +75,9 @@ FxtStore.delete("MY_KEY");
 Text.PrintHelp("MY_KEY"); // this displays "Text from FXT file" again
 ```
 
-A private FXT storage is not supported in San Andreas: The Definitive Edition. Each script there modifies the global FXT storage. This behavior may change in the future.
+> The private FXT storage is not supported in The Trilogy, Bully and GTA IV. Each script there modifies the global FXT storage. This behavior may change in the future.
+
+`insert` and `delete` methods can be forced to change global FXT keys even when the current host supports a private storage. By setting the last argument `isGlobal` to `true` you can mutate (add or delete) keys in the global storage. It might be helpful to deal with those keys that the game uses after procesing all scripts in a given frame (e.g. in delayed messages or HUD elements text) when the script's private storage is not available.
 
 Custom text can be constructed dynamically, e.g.:
 

installer/cleo_redux.iss

@@ -1,5 +1,5 @@
 #define AppName "CLEO Redux"
-#define AppVersion "1.0.4"
+#define AppVersion "1.0.5-dev.20221208"
 #define AppPublisher "Seemann"
 #define AppURL "https://re.cleo.li"
 #define SourceDir "..\"
@@ -61,7 +61,7 @@ Name: "plugins/imgui/d3d8to9"; Description: "d3d8to9 Wrapper - for games using D
 Name: "plugins/imgui/SilentPatch"; Description: "SilentPatch - needed for the mouse to work properly in classic GTA"; Types: full
 Name: "plugins/memops"; Description: "MemoryOperations (by ThirteenAG)"; Types: full
 Name: "plugins/input"; Description: "Input 1.3"; Types: full
-Name: "plugins/frontend"; Description: "Frontend 1.0"; Types: full
+Name: "plugins/frontend"; Description: "Frontend 1.1"; Types: full
 Name: "loaders"; Description: "File Loaders"; Types: full
 Name: "loaders/text"; Description: "*.txt, *.text (Text files)"; Types: full
 Name: "loaders/ide"; Description: "*.ide (Item Definition files)"; Types: full
@@ -169,9 +169,7 @@ Source: "{#SourceDir}\loaders\IdeLoader\build\IdeLoader64.cleo"; DestDir: "{app}
 Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "AllowCs"; String: 1
 Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "AllowJs"; String: 1
 Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "AllowFxt"; String: 1
-Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "CheckUpdates"; String: 1
 Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "LogOpcodes"; String: 0
-Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "DisplayMenuInfo"; String: 1
 Filename: "{app}\CLEO\.config\cleo.ini"; Section: "General"; Key: "PermissionLevel"; String: Lax
 
 ; will be set in wpFinished