3.9.0 Release Plan

[x87]

Breaking Changes

Some old code may not compile in this version. Read through the notes down below.

Download

https://github.com/sannybuilder/dev/releases/tag/v3.9.0

Features

• command names defined in SBL JSON files are now valid keywords (available in GTA III, VC, SA modes)
• HEX..END improvements #230
  • new byte(n) syntax
  • $include adds the file as a binary blob
  • documentation
• inline const and var declarations
  • const x = 1
  • var $x: int
  • comma-separated declarations const x = 1, y = 2, var $x:int, $z: array 10 of int, int x, y = 1, z = 3
  • language service update
  • documentation on inline constants, variables, and arrays
• new operators
  • Bitwise Operations without opcodes #97
  • Support for timed addition and substraction operator =@ #115
  • Support for cast assignment operator =# #116
  • documentation
• Constants are not Highlighted Recursively #134
• Define types for special variables TimerA and TimerB #220
• VAR section of SB Footer should only include USED variable names #244
• {$USE} directive accepts multiple comma-separated extensions
• {$INCLUDE_ONCE CVehicle.h} #196
  • documentation
• Make integration of custom opcodes easier #74
  • Handle missing modes file gracefully #68
  • documentation
• the compiler now throws an error on a duplicate constant declaration
  • document new error code 0090
• third-party updates
  • CLEO 4.4.4 https://github.com/cleolibrary/CLEO4
  • CLEO+ 1.1.5 https://github.com/JuniorDjjr/CLEOPlus
  • help 1.18 https://github.com/MatiDragon-YT/help-system/releases/tag/1.18
• translation updates update for 3.9.0 translations#22
• opcode updates 3.9.0 data#27

Bug Fixes

• Can't use hexadecimal numbers in a for loop #212
• Alloc function does not work as expected #223
• Hint flickers when mouse is hovering over the bottom panel #152
• Auto complete ignores name text case #219
• bug in the constants #190
• wrong compilation when maximum parameters are given to a variadic command #240
• typed variable declaration allows malformed syntax #245
• typed variable declaration should not stomp on timer variables #246
  • document new error code 0091
• while true should require the closing 'end' #247
• +0x - Plus Symbol Used In Hexadecimal Constant core#12
• language service should ignore multi-line comments core#14
• update list of objects after opening a new file with another edit mode (the compiler should not add ped or car models to DEFINE OBJECT list #233)

[x87]

Internal Changes

• new, stricter INI parser. helped to identify some mistakes in the existing files. Old *SCM.INI published elsewhere won't work and likely cause compilation errors.
• split of the modes.xml into individual files. Sanny scans \data directory for folders with mode.xml and treats them as mode configs.
• split of the monolithic SASCM.INI into multiple INI files. Adding extra opcodes is as easy as just dropping a file named SASCM.*.ini into the data\sa folder
• new transform phase in the compiler that helps to process arithmetic operations without an opcode, e.g. it now supports bitwise operators
• command names defined in SBL JSON files are now valid keywords (available in GTA III, VC, SA modes)

[x87]

Breaking Changes

• compiler now throws an error if an unknown* model name is used in a FOR loop range, or inside a HEX..END.

i.e. the following code is no longer valid if MODEL1 and MODEL100 are unknown names.

for 0@ = #MODEL1 to #MODEL100 

hex
 #MODEL1
end

*Unknown model is such a model, that is not defined in the standard IDE files such as default.ide, peds.ide, or vehicles.ide. Or the game directory is not set in the options, so the compiler can't read those files.

Previously the compiler would try to add those modes to the DEFINE OBJECT list if it was an SCM file (not CLEO) and replaced model names with negative indexes in that list, e.g. -1 or -2. This behavior most likely deviates from the script goal and leads to many confusions.

Solution

To compile this code, the compiler should have access to the game's data folder, meaning one should set the game directory in the options. Then, it scans the standard IDE files (see above) and finds an id for the given models (MODEL1 and MODEL100). If such names are not found, another error is thrown.

Alternative path is to replace model names in the code with their respective IDs (numbers).

---

• compiler now throws an error on a duplicate constant declaration. The error code is 0090. Previously Sanny would silently ignore subsequent declarations and use the first value.

const x = 5
const x = 6
0@ = x // it would've been 0@ = 5, now error

Solution

Use unique name for each constant.

---

• compiler is stricter about variable and constant declarations. Previously parser allowed all kind of non-sense and missing syntax elements (missing : in var v int). now parser obeys rules formalized here.

Solution

Update the code to match the spec.

[x87]

Release Notes

beta.2

• {$INCLUDE_ONCE CVehicle.h} #196
• {$USE} directive accepts multiple comma-separated extensions
• fix VAR section of SB Footer should only include USED variable names #244
• -x command-line argument is now parameter-less to reflect the fact there is no modes.xml anymore

beta.1

• fix typed variable declaration allows malformed syntax #245
• fix typed variable declaration should not stomp on timer variables #246
• fix while true should require the closing 'end' #247
• variadic commands may have as few as zero arguments
• fix language service should ignore multi-line comments core#14

beta.0

• documentation hotkey (F12) can be customized in Options->Hotkeys
• add new links in Help menu
• update Turkish translation
• fix wrong compilation when maximum parameters are given to a variadic command #240

alpha.2

• add support for inline and comma-separated const and var declarations

const x = 10
int 0@ = 5, 1@ = 6, 7@ = 10.0
float x, y, z

• the compiler now throws an error on a duplicate constant declaration
• respect the constant name format with autocomplete Auto complete ignores name text case #219
• autocomplete list shows commands when invoked after if or while keywords
• fix Hint flickers when mouse is hovering over the bottom panel #152
• fix Sanny Builder Library #136 (comment)
• fix bug in the constants #190

const
    VarName = $Var
    IndexName = 25
end
VarName[IndexName] = 0

alpha.1

• add support for constants and hexadecimal numbers for n in byte(n) syntax (see 1 below).
• support constant names in bitwise operations (see 3 below)
• support for timed addition and substraction operator =@
• support for cast assignment operator =#
• disassemble invalid floats (NaN) as integer numbers
• fix an error in compiling class props with parenthesis (e.g. 0@ = $PLAYER_CHAR.CurrentCar())
• include CLEO 4.4.4

alpha.0

1. it is now possible to generate a series of repetitive bytes in hex..end using new byte(N) syntax. For example, if you needed 10 zero bytes, you had to write each one individually as follows:

hex
  00 00 00 00 00 00 00 00 00 00
end

Now it is possible to write:

hex
  00(10)
end

there should be no whitespace between a byte and a number of repetitions enclosed in braces. You can use this syntax many times per block:

hex
  00(3) FF 01(4) FF
end

will be unwrapped to

hex
  00 00 00 FF 01 01 01 01 FF
end

N can be a constant defined earlier in the code:

const n = 10

hex
  00(n)
end

2. It is now possible to include a whole file as a binary blob using hex..end and $INCLUDE directive. I.e.

hex
  {$INCLUDE file.bin}
end

will read the file.bin from the disk as a binary file, then insert each byte of it into hex..end, and compile. Common {$INCLUDE} rules apply https://docs.sannybuilder.com/coding/directives#usdinclude

3. Support Bitwise Operations without opcodes #97
   I.e. now this code

0@ = 1@ % 2@
~0@

will be compiled without need for opcodes. See #97 for the complete reference.

4. Each command name defined in .JSON files (from Sanny Builder Library) serves as a keyword for Sanny Builder. It means it is allowed to write a code like this:

get_controller_mode $13
if 
  not $13 == 3
goto_if_false @label1
if 
  is_button_pressed 0 pressed_key 19
goto_if_false @label2

which is similar to SA SCR mode, but does not require any keywords be explicitly declared in keywords.txt.

To support an enormous amount of new keywords in IDE the autocomplete list was limited to 200 names.

6. TIMERA and TIMERB implicitly declared as int variables.

var
 $x: int
end

$x = TIMERA // 008A: $x = TIMERA  // (int)

7. Edit mode configuration changed and mods don't have to be listed in modes.xml anymore. Each mode is a separate folder inside data and their config is located in a mode.xml file. Creating and maintaining your own modes could be done independently from core Sanny Builder files and future updates won't affect them.