update docs, allow overriding all types

Author: makspll

crates/bevy_mod_scripting_display/src/printer/mod.rs

@@ -24,6 +24,16 @@ impl<'f, 'b: 'f, 't> ReflectPrinter<'f, 'b, 't> {
 
     /// Prints a `Reflect` value as if it was its native `Debug` implementation.
     pub fn debug(&mut self, value: &dyn PartialReflect) -> std::fmt::Result {
+        if let Some(type_info_provider) = &self.type_info {
+            if let Some(reflect_type) = value.try_as_reflect()
+                && let Some(display_type_data) = type_info_provider
+                    .get_type_data::<ReflectDisplayWithTypeInfo>(reflect_type.type_id())
+                && let Some(as_dyn_trait) = display_type_data.get(reflect_type)
+            {
+                return as_dyn_trait.display_with_type_info(self.formatter, self.type_info);
+            }
+        }
+
         // try to print the value as if it was its native Debug implementation
         match value.reflect_ref() {
             ReflectRef::Struct(s) => self
@@ -154,20 +164,7 @@ impl<'f, 'b: 'f, 't> ReflectPrinter<'f, 'b, 't> {
                         .finish()
                 }
             }
-            ReflectRef::Opaque(o) => {
-                if let Some(type_info_provider) = &self.type_info {
-                    if let Some(reflect_type) = o.try_as_reflect()
-                        && let Some(display_type_data) =
-                            type_info_provider
-                                .get_type_data::<ReflectDisplayWithTypeInfo>(reflect_type.type_id())
-                        && let Some(as_dyn_trait) = display_type_data.get(reflect_type)
-                    {
-                        return as_dyn_trait.display_with_type_info(self.formatter, self.type_info);
-                    }
-                }
-
-                o.debug(self.formatter)
-            }
+            ReflectRef::Opaque(o) => o.debug(self.formatter),
         }
     }
 

docs/src/Summary/controlling-script-bindings.md

@@ -153,8 +153,10 @@ There are a few reserved functions that you can override by registering them on
 | eq | an equality function, used for checking if two values are equal | ✅ | ❌ |
 | lt | a less than function, used for checking if a value is less than another | ✅ | ❌ |
 | iter | an iterator function, used for iterating over a value | ❌ | ✅ |
-| display | a display function, used for displaying a reference to a value | ❌ | ✅ |
-| debug | a display function, used for displaying a mutable reference to a value | ❌ | ✅ |
+| display | a display function, used for pretty printing values | ❌\* | ✅ |
+| debug | a display function, used for displaying the internals of a value | ❌\* | ✅ |
+
+\* - You can register an instance of `ReflectDisplayWithTypeInfo` type data on `Reflect` implementing types to override their printing behavior
 
 In this context `overridable` indicates whether language implementations will look for a specific function on your type before looking at the generic `ReflectReference` namespace. You can still remove the existing registration for these functions on the `ReflectReference` namespace if you want to replace them with your own implementation.