from_instance_id is main-thread only

Author: TitanNano

godot-core/src/meta/error/convert_error.rs

@@ -162,6 +162,7 @@ pub(crate) enum ErrorKind {
     FromGodot(FromGodotError),
     FromFfi(FromFfiError),
     FromVariant(FromVariantError),
+    InvalidThread,
     // FromAnyArray(ArrayMismatch), -- needed if AnyArray downcasts return ConvertError one day.
     Custom(Option<Cause>),
 }
@@ -172,6 +173,7 @@ impl fmt::Display for ErrorKind {
             Self::FromGodot(from_godot) => write!(f, "{from_godot}"),
             Self::FromVariant(from_variant) => write!(f, "{from_variant}"),
             Self::FromFfi(from_ffi) => write!(f, "{from_ffi}"),
+            Self::InvalidThread => write!(f, "InstanceID can not be converted outside main-thread"),
             Self::Custom(cause) => match cause {
                 Some(c) => write!(f, "{c}"),
                 None => write!(f, "custom error"),

godot-core/src/obj/gd.rs

@@ -13,7 +13,7 @@ use godot_ffi::is_main_thread;
 use sys::{SysPtr as _, static_assert_eq_size_align};
 
 use crate::builtin::{Callable, NodePath, StringName, Variant};
-use crate::meta::error::{ConvertError, FromFfiError};
+use crate::meta::error::{ConvertError, ErrorKind, FromFfiError};
 use crate::meta::shape::GodotShape;
 use crate::meta::{
     AsArg, ClassId, Element, FromGodot, GodotConvert, GodotNullableType, GodotType, RefArg, ToGodot,
@@ -250,9 +250,15 @@ where
 impl<T: GodotClass> Gd<T> {
     /// Looks up the given instance ID and returns the associated object, if possible.
     ///
-    /// If no such instance ID is registered, or if the dynamic type of the object behind that instance ID
-    /// is not compatible with `T`, then `None` is returned.
+    /// # Errors
+    /// - If no such instance ID is registered, or if the dynamic type of the object behind that instance ID
+    ///   is not compatible with `T`, then `Err(...)` is returned.
+    /// - If called outside the main-thread, then `Err(...)` is returned as well.
     pub fn try_from_instance_id(instance_id: InstanceId) -> Result<Self, ConvertError> {
+        if !sys::is_main_thread() {
+            return Err(ConvertError::with_kind(ErrorKind::InvalidThread));
+        }
+
         let ptr = classes::object_ptr_from_id(instance_id);
 
         // SAFETY: assumes that the returned GDExtensionObjectPtr is convertible to Object* (i.e. C++ upcast doesn't modify the pointer)
@@ -267,10 +273,15 @@ impl<T: GodotClass> Gd<T> {
     /// Corresponds to Godot's global function `instance_from_id()`.
     ///
     /// # Panics
-    /// If no such instance ID is registered, or if the dynamic type of the object behind that instance ID
-    /// is not compatible with `T`.
+    /// - If no such instance ID is registered, or if the dynamic type of the object behind that instance ID
+    ///   is not compatible with `T`.
+    /// - If called on a different thread than the main-thread.
     #[doc(alias = "instance_from_id")]
     pub fn from_instance_id(instance_id: InstanceId) -> Self {
+        if !sys::is_main_thread() {
+            panic!("Gd::instance_from_id is can not be called outside the main-thread");
+        }
+
         Self::try_from_instance_id(instance_id).unwrap_or_else(|err| {
             panic!(
                 "Instance ID {} does not belong to a valid object of class '{}': {}",