Update documentation, CHANGELOG, and versions.

Also update template.

Author: fuzzybinary

README.md

@@ -10,6 +10,9 @@ And I want to use it in Godot.
 
 > [!NOTE]  
 > This extension is compatible with Godot 4.2+. Global Classes require Godot 4.3
+> 
+> There are major changes to the entire library starting in `godot_dart` 0.10.0, which uses Dart 3.8. 
+> Previously, `godot_dart` upgraded to 0.9.0 without these changes and is therefore broken.
 
 
 Here's a list of planned features and work still to be done ( ✅ - Seems to be
@@ -68,6 +71,7 @@ part 'simple_script.g.dart';
 @GodotScript()
 class SimpleScript extends Sprite2D  {
   // Return the type info that was generated...
+  @pragma('vm:entry-point')
   static TypeInfo get sTypeInfo => _$SimpleScriptTypeInfo();
   // And provide an instance method to get the type info
   @override
@@ -159,29 +163,34 @@ These signal connections are automatically cleaned up if the target supplied to
 
 ## Dart classes as Extensions
 
-Here's a Simple example class that can be used as an extension.
+Dart classes as extensions have had major changes in `godot_dart` 0.10.0, and are currently a work in progress. Their setup is basically the same as Scripts, except all of the type registration must be done manually.
 
 ```dart
-class Simple extends Sprite2D {
+class SimpleTestNode extends Sprite2D {
   // Create a static `sTypeInfo`. This is required for various Dart methods
   // implemented in C++ to gather information about your type.
-  static late TypeInfo sTypeInfo = TypeInfo(
-    Simple,
-    StringName.fromString('Simple'),
-    parentClass: StringName.fromString('Sprite2D'),
-    // a vTable getter is required for classes that will be used from extensions.
-    // If you are not adding any virtual functions, just return the base class's vTable.    
-    vTable: Sprite2D.sTypeInfo.vTable;
+  static final sTypeInfo = ExtensionTypeInfo<SimpleTestNode>(
+    className: StringName.fromString('SimpleTestNode'),
+    parentTypeInfo: Node.sTypeInfo,
+    nativeTypeName: StringName.fromString('Node'),
+    isRefCounted: Node.sTypeInfo.isRefCounted,
+    constructObjectDefault: () => SimpleTestNode(),
+    constructFromGodotObject: (owner) => SimpleTestNode.withNonNullOwner(owner),
   );
   // An override of [typeInfo] is required. This is how
   // the bindings understand the what types it's looking at.
   @override
-  TypeInfo get typeInfo => sTypeInfo;
-
-  double _timePassed = 0.0;
+  ExtensionTypeInfo<SimpleTestNode> get typeInfo => SimpleTestNode.sTypeInfo;
 
   // Parameterless constructor is required and must call super()
   Simple() : super();
+
+  // Required to create with an owner, though this is not called for Extension classes
+  SimpleTestNode.withNonNullOwner(super.owner) : super.withNonNullOwner();
+
+  double _timePassed = 0.0;
+
+  int maxSpeed = 12559;
   
   // All virtual functions from Godot should be available, and start
   // with a v instead of an underscore.
@@ -196,10 +205,18 @@ class Simple extends Sprite2D {
     setPosition(newPosition);
   }
 
-  // The simplest way to bind your class it to create a static function to
-  // bind it to Godot. The name doesn't matter
-  static void bind() {
-    GDNativeInterface.bindClass(Simple);  
+  // The simplest way to bind your class it to create a static function to bind all properties to Godot, and make sure to add it to the type resolver
+  static void bind(TypeResolver typeResolver) {
+    typeResolver.addType(sTypeInfo);
+    GDNativeInterface.bindClass(SimpleTestNode.sTypeInfo);
+    GDNativeInterface.addProperty(
+      SimpleTestNode.sTypeInfo,
+      DartPropertyInfo<SimpleTestNode, int>(
+          typeInfo: PrimitiveTypeInfo.forType(int)!,
+          name: 'maxSpeed',
+          getter: (self) => self.maxSpeed,
+          setter: (self, value) => self.maxSpeed = value),
+    );
   }
 }
 ```
@@ -212,7 +229,9 @@ These classes need to be registered to Godot in `main.dart`:
 
 ```dart
 void main() {
-  Simple.bind();
+  attachScriptResolver();
+  
+  SimpleTestNode.bind(TypeResolver.instance);
 }
 ```
 

src/assets/src/pubspec.yaml

@@ -8,10 +8,10 @@ environment:
 
 dependencies:
   ffi: ^2.0.1
-  godot_dart: ^0.9.0
+  godot_dart: ^0.10.0
   collection: ^1.17.2
 
 dev_dependencies:
   lints: ^2.0.0
   build_runner: ^2.3.3
-  godot_dart_build: ^0.7.0
+  godot_dart_build: ^0.8.0

src/cpp/editor/dart_templates.cpp

@@ -38,20 +38,19 @@ const char *git_ignore_template = "# Files and directories created by pub\n"
                                   "*.g.dart\n"
                                   "\n";
 
-
 const char *dart_script = "import 'package:godot_dart/godot_dart.dart';\n"
                           "\n"
                           "part '__FILE_NAME__.g.dart';\n"
                           "\n"
                           "@GodotScript()\n"
                           "class __CLASS_NAME__ extends __BASE_CLASS__ {\n"
+                          "  @pragma('vm:entry-point')"
                           "  static TypeInfo get sTypeInfo => _$__CLASS_NAME__TypeInfo();\n"
                           "  @override\n"
                           "  TypeInfo get typeInfo => sTypeInfo;\n"
                           "\n"
                           "  __CLASS_NAME__() : super();\n"
                           "\n"
-                          "  @pragma('vm:entry-point')"
                           "  __CLASS_NAME__.withNonNullOwner(super.owner)\n"
                           "    :super.withNonNullOwner();\n"
                           "\n"

src/dart/godot_dart/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.10.0
+
+- BREAKING: Fix extension to work with more restrictive native calls in Dart 3.8. 
+    - For scripts, `godot_dart_build` should do most migration for you, but you need to add `@pragma('vm:entry-point')` onto your declaration for `sTypeInfo` in all script classes
+    - Extension classes very different, and it is recommended to avoid using them for now. 
+
 ## 0.9.0
 
 - Add type safe `SignalX` objects supporting automatic registering / deregistering.

src/dart/godot_dart/pubspec.yaml

@@ -1,7 +1,7 @@
 name: godot_dart
 description: Dart bindings for the Godot game engine
 repository: https://github.com/fuzzybinary/godot_dart
-version: 0.9.0
+version: 0.10.0
 
 environment:
   sdk: '>=3.6.0 <4.0.0'

src/dart/godot_dart_build/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.0
+
+- BREAKING: Major changes to support more restrictive native calls in Dart 3.8.
+
 ## 0.7.0
 
 - Add the ability to use @GodotProperty on getters.

src/dart/godot_dart_build/pubspec.yaml

@@ -1,7 +1,7 @@
 name: godot_dart_build
 description: build_runner interface for simplifying binding to Godot
 repository: https://github.com/fuzzybinary/godot_dart
-version: 0.7.0
+version: 0.8.0
 
 environment:
   sdk: '>=3.6.0 <4.0.0'
@@ -14,7 +14,7 @@ dependencies:
   build: ^2.0.0
   build_config: ^1.1.1
   source_gen: ^1.3.2
-  godot_dart: '>=0.9.0<1.0.0'
+  godot_dart: '>=0.10.0<1.0.0'
   code_builder: ^4.5.0
   dart_style: ^2.3.1
   glob: ^2.1.2