typed-factorio 0.14.1 → 0.17.1

package/Changelog.md

@@ -1,3 +1,27 @@
+# v0.17.1
+
+- Fixed documentation links for events
+
+# v0.17.0
+
+- Updated to factorio version 1.1.52
+
+# v0.16.0
+
+- `LuaCustomTable` can be iterated on in a for-of loop directly (without using `pairs`). This requires TSTL v1.3.0 or later.
+- TSTL dependency minimum version is now v1.3.0.
+
+# v0.15.0
+
+- Table or array concepts are now declared in table form wherever it is an "read" position.
+  - This works with setter overloading for applicable properties: `player.color.x; player.color = [1, 1, 1]` is now valid!
+  - This also applies to concepts/complex types which contain table_or_array properties.
+- Some concepts now also have a special form where it is known to be in a "read" position, where all table_or_array concepts are declared in table form. These concepts are suffixed with "Read", e.g. `ScriptAreaRead`.
+- Arrays which are known to be in a "write" only form (e.g. method parameters) now are marked readonly. This means you can now pass readonly-only arrays to these methods.
+- `MapPosition` is now a table or array concept.
+- Classes with subclasses are now declared with all properties, instead of an intersection of subclasses (reversion)
+- Subclass specializations added for some missing classes
+
 # v0.14.1
 
 - LuaStyle: `extra_margin/padding_when_activated` is now for subclass scroll_pane
@@ -7,17 +31,17 @@
 - LuaStyle size, margin/padding setters now have more specific array types. These array types are `SizeArray` and `StyleValuesArray` for size and margin/padding, respectively.
 - `@noSelf` annotation is now only present when necessary.
 - For classes with subclasses:
-    - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
-    - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
-    - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
-    - The above two can be optionally used for stricter types.
+  - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
+  - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
+  - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
+  - The above two can be optionally used for stricter types.
 
 # v0.13.2
 
 - Fix: resize_to_sprite property should not be on subclass sprite-button
 - Fix: ChooseElemButtonSpec filters should be named elem_filters
 - Switch back to `/latest` api docs link
-    - New version of web api docs is now active
+  - New version of web api docs is now active
 
 # v0.13.0
 
@@ -53,7 +77,7 @@
 # v0.7.3
 
 - Update to factorio version 1.1.42
-    - No api changes, but improvements to descriptions
+  - No api changes, but improvements to descriptions
 
 # v0.7.2
 

package/README.md

@@ -73,7 +73,7 @@ The `global` table is just a lua table which can have any shape the mod desires,
 
 Typed-factorio has 100% complete types for the runtime stage. Description-only concepts and some not documented types are filled in manually.
 
-Here are some details on particular type features in the definitions:
+Here are some details on particular type features:
 
 ### Lua features
 
@@ -96,6 +96,7 @@ The type for a specific variant is prefixed with the variant name, or with "Othe
 ### Types with subclasses
 
 Some classes have attributes that are documented to only work on particular subclasses. For these classes, e.g. `LuaEntity`, there are also these other types that you can _optionally_ use:
+
 - a "Base" type, e.g. `BaseEntity`, which only contains members usable by all subclasses
 - individual subclass types, e.g. `CraftingMachineEntity`, which extends the base type with members specific to that subclass
 
@@ -111,9 +112,13 @@ You can pass a type parameter to `script.generate_event_name<T>()`, and it will
 
 Classes that have an index operator, a length operator, and have an array-like structure, inherit from `(Readonly)Array`. These are `LuaInventory`, `LuaFluidBox`, `LuaTransportLine`. This allows you to use these classes like arrays, meaning having array methods, and `.length` translating to the lua length operator. However, this also means, like typescript arrays, they are **0-indexed, not 1-indexed**.
 
-### Table or array types
+### Table or array types, and "Read" concepts
+
+For table-or-array types (e.g. Position), there also are types such as `PositionTable` and `PositionArray` that refer to the table or array form.
+
+Table-or-array types will appear in the Table form when known to be in a read position. This also applies to other concepts/complex types that have table-or-array attributes.
 
-For table or array types (e.g. Position), there also are types such as `PositionTable` and `PositionArray` that refer to the table or array form specifically.
+For some concepts, there is also a special form for when the concept is used in a "read" position, where all table-or-array types are in Table form. These types are suffixed with `Read`, e.g. `ScriptPositionRead`.
 
 ### LuaGuiElement