[0.5.10] - 2022-12-23

Features

• Configurable user hints (5df523d503efdd08e16c2a98a4bf4f5ac5c76157)
• File path support in user hints (cef544b6f3fd5c73e186ae0deb99a29407bb6060)
• Switch to a new logger with file rotation (2b589f07e180cfc9c9350f34d0f871b8d031994a)

Contributors

• jekky

[0.6.0-M4] - 2022-12-17

This is a preview milestone release, not intended for regular users

Features

• Re-add qualifier handling (42c482027897d5eafafd6bff6489c87ae0052392)
• Initial implementation of wrapMethod (046fb70e0f7ece7e8d01628497be770a79797afd)
• Add addMethod (6830364b873910153d9a347939db2da2e6c1fa46)

Contributors

• jekky

[0.6.0-M2] - 2022-12-07

This is a preview milestone release, not intended for regular users

Bug Fixes

• Fix name scoping (cc389d918339fdc9e298888f22aec0d1b55936d7)
• Fix minor regressions found when running mods and clean up (7c8c67250973352e2e707772dbe3a43ea89df2eb)

Features

• Generic pretty-printing (99b7660a7a49797084a78a86bcb99995673f4d21)

Contributors

• jekky

[0.6.0-M1] - 2022-11-28

This is a preview milestone release, not intended for regular users. The notable missing feature are annotations.

Bug Fixes

• Make is_same_shape work for primitives (7cb3ec77c50a1dc71e128c0767b2cfda5dedb41f)

Features

• Error reporting for unimplemented methods (b4f65e7d97de2f90b04551f50417afa0d6519528)
• Re-add switch-case (b8ea485d5ee8ac6ba50663aee8d7e8cbe32d5dff)
• Re-add for-in loops, string interpolation and array literals (3b2b5b8ed411a59d7ebe0991e82533cd6ccfa37d)

Contributors

• jekky

[0.6.0-M0] - 2022-11-20

This is a preview release, which is expected to be buggy and incomplete. The details about features coming in 0.6 can be found here. Notable missing features that are yet to be added are:

• most annotations except replaceMethod
• syntax sugar for arrays and for-in loops
• switch case

Features

• Revamped type system (b9b70eca69614a4caa800f660f2d8a14f58f3729)
• Struct&enum boxing and missing boxed types (b6b52ef8d44a396d8f1ba9c1c86dc62ab849f073)
• Re-add struct&enum support (17e109afcd99d570130e104c0a399431b2fd0053)
• Proper handling of overriden generics (76866f5e6a1f5fd744bd4b7447f21e52a52ec110)
• Slightly better errors (0417085af6e14c9e61cf96ae31a0e721ccc4d4f1)
• Re-add replaceMethod annotation (607e59e3dda0ebb3157c6bcb1905af9ac8d9b113)

Contributors

• jekky

[0.5.9] - 2022-11-05

Bug Fixes

• Avoid pool errors in method replacement (4bbb2a17ac69461c35fac3db713099f6746fb8e6)
• Handle missing base class better (5e567a066a0ae455368a0999bd7a141c33c8f498)

Features

• Parse else-if (13d6adc73f2cfb9a652757c21e9e727003a7c21b)

Contributors

• jekky

• recover existing backup when running with redmod (8990183f31db408843dcf3466bf4d5c14615f455)
• add a workaround for a pool error (4284ec6107b1c39a6ea024fa14ecd1ff75a17c81)

note: delete r6\cache\modded if it exists after updating redscript, it'll be regenerated automatically when the game runs

• fix an empty modded directory issue with redmod (ff22d43f7cfcad0bcf11ff1339c6e53f35812b58)

• fix an empty modded directory case (ff22d43f7cfcad0bcf11ff1339c6e53f35812b58)

• added support for running redscript along with redmod scripts (6a9258fdcd8269b9b38bea84ee1d432939b902c6)
  • in order to use redmods with redscript you need to install a new tool cybercmd, the redscript release zip contains configuration which will get picked up by cybercmd automatically once installed
• moved logs to r6/logs and added a new flag for splitting logs files by date (cf1bbc22b41120acb2fcf34da98e66036779c876) (by @ForserX)
• fixed some edge cases around class sorting (b623a189d75d44c65ce2aa9f961edf73c3ac73c7)
• changed scc to return an error status code on failures (91ca225a8af5cc9a3c906a7b788962917069a1fa)

• added support for running redscript along with redmod scripts via cybercmd (6a9258fdcd8269b9b38bea84ee1d432939b902c6)
• moved logs to r6/logs and added a new flag for splitting logs files by date (cf1bbc22b41120acb2fcf34da98e66036779c876) (by @ForserX)
• fixed some edge cases around class sorting (b623a189d75d44c65ce2aa9f961edf73c3ac73c7)
• changed scc to return an error status code on failures (91ca225a8af5cc9a3c906a7b788962917069a1fa)

• support field defaults (2a15c1eb12a9523ba065accc1224bd1f477b4358)

// you can define defaults for fields in classes and structs
// the defaults can only be constants, they cannot contain any complex expressions
class Class {
    let int: Int32 = 1000;
    let enum: EPriority = EPriority.Medium;
    let float: Float = 1.0;
    let string: String = "string";
    let name: CName = n"name";
}

• improve number literal parsing (d06f14c715c18705adfba421619f7a2421be2986)
  • unsigned long literals are now allowed (e.g. 18446744073709551615ul)
  • this also fixes an issue with enums that use negative integers
• better handling of conflicting field additions (da4af0573a6e84a707c49d459783190371dae09d)
  • multiple @addField with the same name will now result in only one field being added to the class (to prevent game crashes)
  • a warning will now be emitted for each conflict
• disable optional diagnostics in scc (to minimize game startup overhead) (3886dd082d466379f62a2b56d374eccb62fa370a)
• support runtime properties (caf8c442de0887b9d544a6e237be02a01e0598ff)

class Class {
    @runtimeProperty("myText", "Lorem ipsum dolor sit amet, consectetur adipiscing elit")
    let int: Int32;
}

• fix String initialization (5a647a976e08b700fae32d625028735e9c4728d1)

Notable Changes:

• local initializers - fixes surprising behavior with some types, particularly arrays (4870193b2493d158106e6f241f760fef89024bfa, 766b6aa6c0fa042a22d955e8d29ad96df260c8cb)
• various improvements for diagnostics (3fb78638c137fabc7da04cf436b45756a63a2b9f)
• various compiler optimizations (5a97c0d39a0cdfaf02ef711a70ca175faf01d012, e487792e820fdf4eee085b78a9d1b374a7531c4e)

Contributors:

git shortlog -sn --no-merges v0.5.2..v0.5.3
    23  jekky

Notable Changes:

• fix an operator precedence issue (f0edc543396ebb10d9748ea100cb533965d0dc4c)
• fix a multi-byte character issue (b9b1adb78c6f03e582614400380b1ffd2740f1d3)
• add experimental support for structs (a9f44b5763131075525c062504eec4d6fdfbafac)
• add basic diagnostics for unused variables and missing return statements (c1573ecba707da64aba71c78ea87e4c69bbaf130)

Contributors:

git shortlog -sn --no-merges v0.5.1..v0.5.2
    9  jekky

Notable Changes:

• fix an encoding issue which would cause the game to hang for 10 seconds before starting (af8857e6c22c5204c6b643b1193a39302b578686)
• handle empty CNames correctly (e980cc5cb553db4b1da542a216f38ec072b765a0)
  • this enables use of methods like TDBID.None and enum members which were previously shown as Unknown
• only show fatal errors in the scc popup (the previous behaviour would misleadingly show mods with compilation warnings as broken) (fc02231bcdd52d6d3621f306246c77a4ca77dd93)
• log a nice warning when running against an incompatible game version (5f038bbf8d470d8875f4bfc7e096dfa01c46742f)
• fix an issue which would lead to confusing pool errors (53e55a02b05f07c6bd4f2551b883a31daf68c6d9)
• be more permissive for some uses of null (like in IsDefined) (ad5d21bd32aabf87b1575d493f7102f0a37fa54b)

Contributors:

git shortlog -sn --no-merges v0.5.0..v0.5.1
    14  jekky

Notable Changes:

• support for the 1.5 game update (af21a68a6ec3f17c333f0553ab6c96b130bd133b)

Contributors:

git shortlog -sn --no-merges v0.4.2..v0.5.0
     3  jekky

Notable Changes:

• support for the 1.5 game update (af21a68a6ec3f17c333f0553ab6c96b130bd133b)

Contributors:

git shortlog -sn --no-merges v0.4.2..v0.5.0-RC1
     2  jekky

Notable Changes:

• experimental support for the persistent keyword (5b2821382c8cbee9838199f80cb0ac7055ad9f0f)

Contributors:

git shortlog -sn --no-merges v0.4.1..v0.4.2
    12  jekky

Notable Changes:

• fix an issue with wrapped callback methods (a6a22cfd890ff1079b7bcd626cf6b211f93156a4)

Contributors:

git shortlog -sn --no-merges v0.4.0..v0.4.1
     6  jekky

Notable Changes:

• add string interpolation (493b983)

// create interpolated strings using the 's' prefix
// expressions inside the \() blocks will be converted to strings
Log(s"My name is \(name) and I am \(year - birthYear) years old");

• add conditional compilation (currently restricted to classes, functions and imports) (1fc9d2c)

module My.Mod
// conditional import
// it'll be available only when the module is present
@if(ModuleExists("Other.Mod"))
import Other.Mod.*

// you can write two different versions of a function based on existence of another module
// imports from Other.Mod will be available only in the first version, since the import was conditional
@if(ModuleExists("Other.Mod"))
func Testing() -> Int32 {
    return 1;
}
@if(!ModuleExists("Other.Mod"))
func Testing() -> Int32 {
    return 2;
}

• enforce basic correctness rules for native and abstract classes/functions (da8dd33)
• allow native and importonly classes (d2070bb)
• allow semicolon after all function declarations (f91bb35)
• fix an issue affecting locals with conflicting names (50c6955)
• extended support for Variant native type (c9850e6)
  • added implicit ToVariant() conversion when the expected TypeId is Variant
  • added the remaining Variant intrinsic operations (VariantIsRef, VariantIsArray and VariantTypeName)
  • extended ToString() and IsDefined() intrinsics to support their Variant counterparts

// Implicit conversion
let v: Variant = new SomeClass();
// ToString support
let s: String = ToString(v);
// Get the type stored in a variant
let n: CName = VariantTypeName(v);
// IsDefined support and variant intrinsics
if IsDefined(v) && VariantIsRef(v) && !VariantIsArray(v) {
  // ...
}

• new function resolution algorithm (8d604af)
  • the new algorithm is a bit more strict, but it makes operator overloads and casts work more predictably
  • it no longer allows using expressions that can resolve to different types inside 'overloaded' contexts - this means that you can no longer use Cast(x), FromVariant(x) and IntEnum(x) inside calls to operators, overloaded methods and casts
  • a new syntax has been introduced to solve this - you can now write Cast<Float>(x), FromVariant<ItemID> and IntEnum<gamedataItemType> to explicitly specify the desired type
  • most of your code will probably still work - this change rarely affects anything except for Castss inside operators
  • the decompiler was updated to generate code that conforms to the new algorithm

func Testing() {
  // the line below will no longer compile!
  // let a = 0.1 + Cast(1);
  // you can write it like this:
  let a = 0.1 + Cast<Float>(1);
  // IMPORTANT
  // you can make your code forwards-compatible though!
  // you can support both versions of the redscript compiler by extracting the Cast to a local:
  let tmp: Float = Cast(1);
  let a = 0.1 + tmp;
}

• improved type inference for conditionals and array literals (79d2dc8)

func Testing() {
    // we infer the most general type to use for the array (array<ref<a>>)
    let a = [ new C(), new B(), new D() ];
    // the type of 'b' is ref<B>
    let b = true ? new C() : new B();
}

class A {}
class B extends A {}
class C extends B {}
class D extends A {}

Contributors:

git shortlog -sn --no-merges v0.3.4..v0.4.0        
    44  jekky
     1  Reece Sheppard

Notable Changes:

• extended support for Variant native type (c9850e6)
  • added implicit ToVariant() conversion when the expected TypeId is Variant
  • added the remaining Variant intrinsic operations (VariantIsRef, VariantIsArray and VariantTypeName)
  • extended ToString() and IsDefined() intrinsics to support their Variant counterparts

// Implicit conversion
let v: Variant = new SomeClass();
// ToString support
let s: String = ToString(v);
// Get the type stored in a variant
let n: CName = VariantTypeName(v);
// IsDefined support and variant intrinsics
if IsDefined(v) && VariantIsRef(v) && !VariantIsArray(v) {
  // ...
}

• new function resolution algorithm (8d604af)
  • the new algorithm is a bit more strict, but it makes operator overloads and casts work more predictably
  • it no longer allows using expressions that can resolve to different types inside 'overloaded' contexts - this means that you can no longer use Cast(x), FromVariant(x) and IntEnum(x) inside calls to operators, overloaded methods and casts
  • a new syntax has been introduced to solve this - you can now write Cast<Float>(x), FromVariant<ItemID> and IntEnum<gamedataItemType> to explicitly specify the desired type
  • most of your code will probably still work - this change rarely affects anything except for Castss inside operators
  • the decompiler was updated to generate code that conforms to the new algorithm

func Testing() {
  // the line below will no longer compile!
  // let a = 0.1 + Cast(1);
  // you can write it like this:
  let a = 0.1 + Cast<Float>(1);
  // IMPORTANT
  // you can make your code forwards-compatible though!
  // you can support both versions of the redscript compiler by extracting the Cast to a local:
  let tmp: Float = Cast(1);
  let a = 0.1 + tmp;
}

• improved type inference for conditionals and array literals (79d2dc8)

func Testing() {
    // we infer the most general type to use for the array (array<ref<a>>)
    let a = [ new C(), new B(), new D() ];
    // the type of 'b' is ref<B>
    let b = true ? new C() : new B();
}

class A {}
class B extends A {}
class C extends B {}
class D extends A {}

Contributors:

git shortlog -sn --no-merges v0.4.0-RC1..v0.4.0-RC2

     14  jekky
     1  Reece Sheppard

This is a pre-release mainly targeted at developers, not end users! If you're just looking for the latest version, check the 0.3.x release series.

Notable Changes:

• add string interpolation (493b983)

// create interpolated strings using the 's' prefix
// expressions inside the \() blocks will be converted to strings
Log(s"My name is \(name) and I am \(year - birthYear) years old");

• add conditional compilation (currently restricted to classes, functions and imports) (1fc9d2c)

module My.Mod
// conditional import
// it'll be available only when the module is present
@if(ModuleExists("Other.Mod"))
import Other.Mod.*

// you can write two different versions of a function based on existence of another module
// imports from Other.Mod will be available only in the first version, since the import was conditional
@if(ModuleExists("Other.Mod"))
func Testing() -> Int32 {
    return 1;
}
@if(!ModuleExists("Other.Mod"))
func Testing() -> Int32 {
    return 2;
}

• enforce basic correctness rules for native and abstract classes/functions (da8dd33)
• allow native and importonly classes (d2070bb)
• allow semicolon after all function declarations (f91bb35)
• fix an issue affecting locals with conflicting names (50c6955)

Contributors:

git shortlog -sn --no-merges v0.3.3..v0.3.4

    24  jekky

Notable Changes:

• fix encoding of native functions (7504d4162e0b2ce78c181c88f49213e96df9281f)
• fix decoding of multi-byte unicode characters (c25bca75dfc0bb1813db439da798f76eef253b86)
• fix an issue with classes being sorted incorrectly sometimes (85ebd54f3d13fbd4fb10fbec8b09b538a556e10d)

Contributors:

git shortlog -sn --no-merges v0.3.3..v0.3.4

     5  jekky
     2  Reece Sheppard

Notable Changes:

• use mmap for reading script bundles - this dramatically reduces startup time of the compiler (especially on HDDs) (8fa3ee1f8190c1201f2e190f74a3a954063b066b)
• add implicit conversions on member access (048852757a705dabe1140971037b1b8bf6e002b9)
• fix a switch-case fallthrough bug in the decompiler (9145e0d1eab4ad33ea6bd733f60ef54aa8d1a3a6)

Contributors:

git shortlog -sn --no-merges v0.3.2..v0.3.3

     7  jekky

Notable Changes:

• no longer stop at the first error when compiling functions (9c284208a25a2d3db90a701ff60a879de13ca506)
  • the compiler will output all errors in the stdout
  • the error popup in scc.exe will list all broken scripts on startup (not just the first one)
  • it's limited to errors inside function bodies for now
• do not allow class redefinitions (06336d81d0208a326aca79c3e36fcff8bb91b1c3)
• fix duplication of classes in the decompiler output (0dcce57e22743af7ef327cfe2255d6e53c083f75)

Contributors:

git shortlog -sn --no-merges v0.3.1..v0.3.2

     7  jekky

Notable Changes:

• fix an issue with some calls that include script_ref values (33e2ecc66e1ce20ca69dd01966b8597c1352f9fd)
• display a popup when the compilation fails in scc (b35d7d12c1ebe3869ad60a026ca571150c19538c)

Contributors:

git shortlog -sn --no-merges v0.3.0..v0.3.1

     4  jekky

Notable Changes:

• support for the 1.3 patch - this is the first version of the compiler that drops compatibility with older versions of the game due to many breaking changes in the binary format of the scripts introduced in the patch (6e7030e)
• fix an issue with mixed wrap/replace annotations (d75382f)
• fix an issue with return instructions being encoded incorrectly in void functions (147e512)
• improvements to method resolution compilation errors (5b11ebf)
• sort classes after compilation to prevent game crashes (364d3d4)

Contributors:

git shortlog -sn --no-merges v0.2.4..v0.3.0

    22  jekky
     1  Reece Sheppard

• sort classes after compilation to prevent game crashes (364d3d45ecac3d1f65551254febbbbf7bf9a2191)
• limit the amount of function overload errors (7d4f756fbb6628c2a01a99822bba7758fd212407)

• attempt to fix an issue with some string functions causing crashes (d611344070d2e10b0776bde34095941474bfcbde)
• avoid exponential explosion of cases in function resolution leading to the compiler hanging (33ef7bcd248ba6911b1199b31fec6031572dc6b0)