fix: prevent ropes from automatically disconnecting when switching editor scenes

Author: arocull

stag-toolkit/src/classes/island.rs

@@ -1,14 +1,13 @@
 use crate::classes::island_settings::IslandBuilderSettings;
 use crate::math::bounding_box::BoundingBox;
 use crate::mesh::island::{Data, IslandBuilderSettingsTweaks, SettingsTweaks};
+use crate::mesh::trimesh::TriangleMesh;
 use crate::{
     classes::utils::editor_lock,
     math::types::ToVector3,
     mesh::godot::{GodotSurfaceArrays, GodotWhitebox},
 };
 use core::f32;
-use std::thread;
-use std::thread::JoinHandle;
 use glam::Vec3;
 use godot::classes::{Engine, ImporterMesh, ResourceLoader};
 use godot::register::ConnectHandle;
@@ -19,7 +18,8 @@ use godot::{
     },
     prelude::*,
 };
-use crate::mesh::trimesh::TriangleMesh;
+use std::thread;
+use std::thread::JoinHandle;
 
 /// The node group IslandBuilder nodes should be stored in.
 pub const GROUP_NAME: &str = "StagToolkit_IslandBuilder";
@@ -115,10 +115,10 @@ impl INode3D for IslandBuilder {
     }
 
     fn process(&mut self, _delta: f64) {
-        if let Some(preview_thread) = &self.realtime_preview_thread {
-            if preview_thread.is_finished() {
-                self.wait_for_preview_finish(); // join preview if it's done
-            }
+        if let Some(preview_thread) = &self.realtime_preview_thread
+            && preview_thread.is_finished()
+        {
+            self.wait_for_preview_finish(); // join preview if it's done
         }
     }
 }
@@ -219,7 +219,8 @@ impl IslandBuilder {
     #[func]
     fn set_realtime_preview(&mut self, realtime_preview: bool) {
         self.realtime_preview = realtime_preview;
-        self.base_mut().set_process(realtime_preview && Engine::singleton().is_editor_hint());
+        self.base_mut()
+            .set_process(realtime_preview && Engine::singleton().is_editor_hint());
 
         // Wait for any existing preview to finish before moving on
         self.wait_for_preview_finish();
@@ -231,7 +232,7 @@ impl IslandBuilder {
 
     fn wait_for_preview_finish(&mut self) {
         if let Some(handle) = self.realtime_preview_thread.take() {
-            let data = handle.join().unwrap();
+            let data = handle.join().expect("realtime preview thread panicked");
             if let Some(trimesh) = data {
                 // Fetch previously stored buffer and clear it for use, or create a new one
                 let buffer_mesh: Gd<ArrayMesh> = match self.realtime_preview_mesh_buffer.take() {
@@ -263,7 +264,12 @@ impl IslandBuilder {
         }
     }
 
-    fn apply_preview_mesh(&mut self, mut mesh_node: Gd<MeshInstance3D>, mut array_mesh: Gd<ArrayMesh>, trimesh: &TriangleMesh) {
+    fn apply_preview_mesh(
+        &mut self,
+        mut mesh_node: Gd<MeshInstance3D>,
+        mut array_mesh: Gd<ArrayMesh>,
+        trimesh: &TriangleMesh,
+    ) {
         let surface_arrays = GodotSurfaceArrays::from_trimesh(trimesh);
         array_mesh.add_surface_from_arrays(
             PrimitiveType::TRIANGLES,

stag-toolkit/src/classes/rope.rs

@@ -850,14 +850,17 @@ impl SimulatedRopeBinding {
         if let Some(rope) = new_bind_to {
             self.signals().rope_bound().emit(&rope);
 
-            // Automatically remove rope if it is removed from tree
-            self.event_rope_tree_exiting = Some(
-                rope.signals()
-                    .tree_exiting()
-                    .builder()
-                    .flags(ConnectFlags::ONE_SHOT)
-                    .connect_other_mut(&self.to_gd(), Self::clear_bind),
-            );
+            // Automatically remove rope if it is removed from tree.
+            // Note: DO NOT disconnect the binding automatically if the rope is exiting the tree inside the editor!
+            if !Engine::singleton().is_editor_hint() {
+                self.event_rope_tree_exiting = Some(
+                    rope.signals()
+                        .tree_exiting()
+                        .builder()
+                        .flags(ConnectFlags::ONE_SHOT)
+                        .connect_other_mut(&self.to_gd(), Self::clear_bind),
+                );
+            }
         }
     }
 
@@ -900,7 +903,9 @@ impl SimulatedRopeBinding {
     /// Updates the bind settings on this [SimulatedRopeBinding]'s corresponding rope.
     #[func]
     fn update_bind(&mut self) {
-        if let Some(mut rope) = self.bind_to.clone() {
+        if let Some(mut rope) = self.bind_to.clone()
+            && rope.is_inside_tree()
+        {
             let pos = rope.to_local(self.base().get_global_position());
             rope.bind_mut()
                 .bind_set(self.get_bind_id(), pos, self.bind_at);

stag-toolkit/src/mesh/island.rs

@@ -494,7 +494,11 @@ impl Data {
         let (mut voxels, transform) = self.bake_voxels_init();
 
         #[cfg(debug_assertions)]
-        assert_ne!(0, voxels.get_buffer_size(), "voxel buffer size is zero, did you bake a bounding box?");
+        assert_ne!(
+            0,
+            voxels.get_buffer_size(),
+            "voxel buffer size is zero, did you bake a bounding box?"
+        );
 
         let mut voxel_workers = voxels.to_workers(
             utils::worker_count(voxels.get_buffer_size(), 16usize).get(),

stag-toolkit/src/utils.rs

@@ -8,8 +8,9 @@ pub fn thread_count(default_thread_count: usize) -> NonZero<usize> {
         default_thread_count, 0,
         "default thread count cannot be zero"
     );
-    available_parallelism()
-        .unwrap_or_else(|_| NonZero::new(default_thread_count).expect("zero-value default thread count provided"))
+    available_parallelism().unwrap_or_else(|_| {
+        NonZero::new(default_thread_count).expect("zero-value default thread count provided")
+    })
 }
 
 /// Returns the number of workers desired for the given workload size.