Skip to content

Latest commit

 

History

History
103 lines (85 loc) · 4.92 KB

CHANGELOG.md

File metadata and controls

103 lines (85 loc) · 4.92 KB
Raw

Changelog

[2.1.3] (2024-11-24)

Update README

  • fixed link to auto-generated typedoc.

[2.1.2] (2024-11-24)

Update README

  • fixed link to auto-generated typedoc.

[2.1.1] (2024-11-24)

Blueprint structure

  • Item costs and recipes in a blueprint are now correctly treated as ObjectReference, instead a single path string.

Internal Updates

  • Migrated the rest of the generic properties towards namespaces

Updated README examples

Provided auto-generated typedoc

[2.0.1] (2024-10-31)

Normal Properties Update

  • Most Normal Properties classes got refactored to namespaces as well. More will come. Please refrain from using instances of them. Background being, that its anyway only static methods and types.
  • Since normal properties of an object are effectively always of type AbstractBaseProperty | AbstractBaseProperty[], the AbstractBaseProperty has now all fields and BasicProperty got removed as there is no difference anymore between the two. They would be the same now.
  • type guards of "normal" properties like isObjectProperty() accept now any as parameter and should work now as expected
  • Since ArrayProperties and SetProperties in the save format dont necessarily always have the same structure as their subtype, I introduced own types like StrArrayProperty and Int32SetProperty with corresponding type guards (e.g. isStrArrayProperty()). Means more overhead in code, but hence its more correct in usage.

Bugfix

  • The total conveyor length in the special properties of a ConveyorChainActor got serialized as int32, but correctly now serialize as float32.

[1.1.1] (2024-10-21)

Improved Special Properties

  • Improved on SpecialProperties of BuildableSubsystem and ConveyorChainActor as the meaning became more clear.
  • Special Properties are refactored into their own namespaces and exported.
  • The union type SpecialAnyProperties is now automatically derived and more concisely named SpecialProperties.AvailableSpecialPropertiesTypes instead, in case you need it.

[1.0.3] (2024-10-17)

Hotfix

  • fix being forced to use callbacks when writing saves or blueprints.

[1.0.2] (2024-10-17)

Internal renaming

  • ...SpecialProperty got all renamed to ...SpecialProperties.

[1.0.1] (2024-10-17)

Major breaking changes on Parser usage

  • Cleaned Usage methods of Save / Blueprint Parsing. The callbacks are an optional additional parameter object now instead of required.
  • Re-Added a method to parse Saves in memory again. (sorry for the inconvenience)

Internal structure changes

  • SatisfactorySave structure changed, the grids and gridHash fields are slightly different now, since their meaning became more clear. Not relevant for normal save editing.
  • Level is a namespace instead of a class now, since the classes had only static methods anyway.

module build now includes source maps

module build should now include a docs folder for auto-generated documentation

[0.5.1] (2024-10-15)

Added Mod Support

Internal Renamings

  • DynamicStructPropertyValue extracted to own file.
  • Parsing of object data partially moved to SaveObject.
  • Renamed DataFields class to PropertiesList.
  • Moved parsing of class-specific properties into own namespace.
  • ObjectProperty and SoftObjectProperty now reuse the correct method for parsing/serializing the reference value.

[0.4.22] (2024-10-07)

compatibility fix

  • referenced icon libraries in blueprints are now optional when being parsed.

[0.4.21] (2024-10-07)

internal package restructuring

  • restructured some internal packages.
  • provides now typeguards for every property.

[0.4.20] (2024-10-06)

bugfix

  • added parsing of icon library reference to parsing blueprints.

[0.4.19] (2024-10-06)

Migrated repo to public github

[0.4.18] (2024-10-05)

updated README

[0.4.17] (2024-10-05)

updated README

bugfix

  • ClientIdentityInfo field names and structure got changed, since the meaning is now more clear.
  • removed trailing object list from satisfactory save object.
  • deleted entities references get serialized again, just based on collectables list.

[0.4.16] (2024-10-03)

bugfix

  • exporting isSaveEntity and isSaveComponent again.

[0.4.15] (2024-10-02)

updated README

  • changelog document doesn't seem linkable, so it is in the readme for now.

[0.4.14] (2024-10-02)

updated README

  • updated the code examples with more context

Internal renamings (won't affect you if you stick to the code examples)

  • improved the interface for abstract parser classes
  • extended some error log messages
  • added an additional check when parsing struct property InventoryItem, since ported saves often have a few more bytes.
  • changed function name writeFloat() to writeFloat32() of the save writer.
  • changed variable name saveOrBlueprintIndicator to objectVersion for objects, since the meaning of that number became now more clear.