UE 5.6 (#119)

Adapt Unreal Example:
+ Updated project file to UE5.6
+ Reload example story (inkcpp compiler changed since last release).

Minor Code Changes:
+ Reorder member initializer
+ Add virtual destructor

UE5.6 API changes:
+ Editor plugin now needs no notify if it exists
(`ShouldFindEditorForAsset`), we do not support an in-engine editor.

PIpelineChanges:
+ Add artifact for UE5.6

BuildSystem:
+ Set UE5.6 as the default UE version for building.

---------

Co-authored-by: Julian <lukasklause@gmail.com>

Author: JBenda

.github/workflows/build.yml

@@ -117,10 +117,18 @@ jobs:
       working-directory: ${{github.workspace}}/build
       shell: bash
       run: |
+        cmake $GITHUB_WORKSPACE -DINKCPP_UNREAL_TARGET_VERSION="5.6" -DINKCPP_UNREAL=ON
+        cmake --install . --config $BUILD_TYPE --prefix comp_unreal_5_6 --component unreal
         cmake $GITHUB_WORKSPACE -DINKCPP_UNREAL_TARGET_VERSION="5.5" -DINKCPP_UNREAL=ON
         cmake --install . --config $BUILD_TYPE --prefix comp_unreal_5_5 --component unreal
         cmake $GITHUB_WORKSPACE -DINKCPP_UNREAL_TARGET_VERSION="5.4" -DINKCPP_UNREAL=ON
         cmake --install . --config $BUILD_TYPE --prefix comp_unreal_5_4 --component unreal
+    - name: Upload UE 5.6
+      if: ${{ matrix.unreal }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: unreal_5_6
+        path: build/comp_unreal_5_6/
     - name: Upload UE 5.5
       if: ${{ matrix.unreal }}
       uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -26,12 +26,12 @@ jobs:
         run: |
           mkdir artifacts
           ID=$(gh run list -b master --limit 1 --json databaseId | jq '.[0].databaseId')
-          gh run download $ID -D artifacts -n linux-cl -n linux-lib -n linux-clib -n unreal_5_5 -n unreal_5_4 -n macos-cl -n macos-lib -n macos-clib -n macos-arm-cl -n macos-arm-lib -n macos-arm-clib -n win64-cl -n win64-lib -n win64-clib -n python-package-distribution
+          gh run download $ID -D artifacts -n linux-cl -n linux-lib -n linux-clib -n unreal_5_6 -n unreal_5_5 -n unreal_5_4 -n macos-cl -n macos-lib -n macos-clib -n macos-arm-cl -n macos-arm-lib -n macos-arm-clib -n win64-cl -n win64-lib -n win64-clib -n python-package-distribution
           mv artifacts/python-package-distribution dist
       - name: Zip
         working-directory: ${{github.workspace}}/artifacts
         run: |
-          for f in linux-cl linux-lib linux-clib unreal_5_5 unreal_5_4 macos-cl macos-lib macos-clib macos-arm-cl macos-arm-lib macos-arm-clib win64-cl win64-lib win64-clib; do zip -r ../$f.zip $f; done
+          for f in linux-cl linux-lib linux-clib unreal_5_6 unreal_5_5 unreal_5_4 macos-cl macos-lib macos-clib macos-arm-cl macos-arm-lib macos-arm-clib win64-cl win64-lib win64-clib; do zip -r ../$f.zip $f; done
       - name: List
         run: tree
       - name: Publish to PyPI
@@ -45,5 +45,5 @@ jobs:
               --repo="$GITHUB_REPOSITORY" \
               --title="${GITHUB_REPOSITORY#*/} ${tag#v}" \
               --generate-notes \
-              "$tag" "linux-cl.zip" "linux-lib.zip" "linux-clib.zip" "unreal_5_5.zip" "unreal_5_4.zip" "macos-cl.zip" "macos-lib.zip" "macos-clib.zip" "win64-cl.zip" "macos-arm-cl.zip" "macos-arm-lib.zip" "macos-arm-clib.zip" "win64-lib.zip" "win64-clib.zip"
+              "$tag" "linux-cl.zip" "linux-lib.zip" "linux-clib.zip" "unreal_5_6.zip" "unreal_5_5.zip" "unreal_5_4.zip" "macos-cl.zip" "macos-lib.zip" "macos-clib.zip" "win64-cl.zip" "macos-arm-cl.zip" "macos-arm-lib.zip" "macos-arm-clib.zip" "win64-lib.zip" "win64-clib.zip"
 

Documentation/unreal/InkCPP_DEMO.zip

@@ -57,7 +57,7 @@ mkdir build
 cd build
 mkdir plugin
 mkdir plugin-build
-cmake -DINKCPP_UNREAL_TARGET_VERSION="5.5" .
+cmake -DINKCPP_UNREAL_TARGET_VERSION="5.5" ..
 cmake --install . --component unreal --prefix .\plugin  # create source files for plugin
 \PATH\TO\UNREAL_ENGINE\Build\BatchFiles\RunUAT.bat BuildPlugin -plugin=GIT_REPO\build\plugin\inkcpp\inkcpp.uplugin -package=GIT_REPO\build\plugin-build\inkcpp -TargetPlatforms=Win64 # compile plugin
 move plugin-build\inkcpp UE_ENGINE\Engine\Plugins\inkcpp

README.md

@@ -187,8 +187,8 @@ class avl_array
 	// ctor
 	avl_array()
 	    : size_(0U)
-	    , root_(INVALID_IDX)
 	    , _capacity(Size)
+	    , root_(INVALID_IDX)
 	{
 		if constexpr (dynamic) {
 			key_     = new Key[Size];

inkcpp/avl_array.h

@@ -24,6 +24,7 @@ namespace runtime
 		{
 		protected:
 			basic_stream(value*, size_t);
+			virtual ~basic_stream() = default;
 			void         initelize_data(value*, size_t);
 			virtual void overflow(value*& buffer, size_t& size, size_t target = 0);
 

inkcpp/output.h

@@ -1,4 +1,4 @@
-set(INKCPP_UNREAL_TARGET_VERSION "5.5" CACHE STRING "Unreal engine version the plugin should target (e.g: 5.5)")
+set(INKCPP_UNREAL_TARGET_VERSION "5.6" CACHE STRING "Unreal engine version the plugin should target (e.g: 5.6)")
 set(INKCPP_UNREAL_RunUAT_PATH CACHE FILEPATH "Path to Unreal engine installation RunUAT file. Used to automatcally build the plugin.")
 option(INKCPP_UNREAL "Prepare sourcefiles for a UE Plugin (this will download " OFF)
 	option(INKCPP_DOC_BlueprintUE "Building doxygen documentation with BlueprintUE visualisation for unreal blueprints. (Requires node js)" ON)

unreal/CMakeLists.txt

@@ -40,6 +40,8 @@ class FInkAssetActions : public IAssetTypeActions
 		}
 	}
 
+	bool ShouldFindEditorForAsset() const override { return false; }
+
 	// Inherited via IAssetTypeActions
 	void OpenAssetEditor(
 	    const TArray<UObject*>& InObjects, TSharedPtr<IToolkitHost> EditWithinLevelEditor