Refactor SceneManager / Transform; fix a number of bugs in scene/game object traversal

.gitignore

@@ -1,3 +1,4 @@
 /target
 /Cargo.lock
 .idea
+**/.DS_Store

src/game_engine/unity/il2cpp/class.rs

@@ -13,7 +13,20 @@
 }
 
 impl Class {
-    pub(super) fn get_name<const N: usize>(
+    pub fn get_from_component(
+        process: &Process,
+        module: &Module,
+        component: Address,
+    ) -> Result<Self, Error> {
+        process
+            .read_pointer(component, module.pointer_size)
+            .ok()
+            .filter(|val| !val.is_null())
+            .map(|class| Class { class })
+            .ok_or(Error {})
+    }
+
+    pub fn get_name<const N: usize>(
         &self,
         process: &Process,
         module: &Module,

src/game_engine/unity/mono/class.rs

@@ -7,13 +7,13 @@
 pub use asr_derive::MonoClass as Class;
 
 /// A .NET class that is part of an [`Image`](Image).
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, Debug)]
 pub struct Class {
-    pub(super) class: Address,
+    pub class: Address,
 }
 
 impl Class {
-    pub(super) fn get_name<const N: usize>(
+    pub fn get_name<const N: usize>(
         &self,
         process: &Process,
         module: &Module,
@@ -215,3 +215,30 @@
         retry(|| self.get_parent(process, module)).await
     }
 }
+
+/** Represents a MonoObject, which is an instantiation of a MonoVTable (and therefore MonoClass). It
+ * is where the actual fields of the class live.
+ *
+ * See https://github.com/mono/mono/blob/0f53e9e151d92944cacab3e24ac359410c606df6/mono/metadata/object.h#L31.
+ */
+pub struct Object {
+    pub address: Address,
+}
+
+impl Object {
+    /** Get the class of this object */
+    pub fn get_class(&self, process: &Process, module: &Module) -> Result<Class, Error> {
+        process
+            // MonoVTable *vtable
+            // See https://github.com/mono/mono/blob/0f53e9e151d92944cacab3e24ac359410c606df6/mono/metadata/object.h#L32
+            .read_pointer(self.address, module.pointer_size)
+            .ok()
+            .filter(|val| !val.is_null())
+            // MonoClass *klass
+            // See https://github.com/mono/mono/blob/0f53e9e151d92944cacab3e24ac359410c606df6/mono/metadata/class-internals.h#L360
+            .and_then(|addr| process.read_pointer(addr, module.pointer_size).ok())
+            .filter(|val| !val.is_null())
+            .map(|class| Class { class })
+            .ok_or(Error {})
+    }
+}

src/game_engine/unity/mono/mod.rs

@@ -16,7 +16,7 @@ use assembly::Assembly;
 mod image;
 pub use image::Image;
 mod class;
-pub use class::Class;
+pub use class::{Class, Object};
 mod field;
 use field::Field;
 mod version;

src/game_engine/unity/mono/offsets.rs

@@ -241,118 +241,126 @@ impl MonoOffsets {
                 },
                 v_table: MonoVTableOffsets { vtable: 0x28 },
             }),
-            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V3, PointerSize::Bit64) => Some(&Self {
-                assembly: AssemblyOffsets {
-                    aname: 0x10,
-                    image: 0x60,
-                },
-                image: ImageOffsets { class_cache: 0x4D0 },
-                hash_table: HashTableOffsets {
-                    size: 0x18,
-                    table: 0x20,
-                },
-                class: ClassOffsets {
-                    parent: 0x28,
-                    image: 0x38,
-                    name: 0x40,
-                    namespace: 0x48,
-                    vtable_size: 0x54,
-                    fields: 0x90,
-                    runtime_info: 0xC8,
-                    field_count: 0xF8,
-                    next_class_cache: 0x100,
-                },
-                field: FieldInfoOffsets {
-                    name: 0x8,
-                    offset: 0x18,
-                    alignment: 0x20,
-                },
-                v_table: MonoVTableOffsets { vtable: 0x48 },
-            }),
-            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V2, PointerSize::Bit64) => Some(&Self {
-                assembly: AssemblyOffsets {
-                    aname: 0x10,
-                    image: 0x60,
-                },
-                image: ImageOffsets { class_cache: 0x4C0 },
-                hash_table: HashTableOffsets {
-                    size: 0x18,
-                    table: 0x20,
-                },
-                class: ClassOffsets {
-                    parent: 0x28,
-                    image: 0x38,
-                    name: 0x40,
-                    namespace: 0x48,
-                    vtable_size: 0x54,
-                    fields: 0x90,
-                    runtime_info: 0xC8,
-                    field_count: 0xF8,
-                    next_class_cache: 0x100,
-                },
-                field: FieldInfoOffsets {
-                    name: 0x8,
-                    offset: 0x18,
-                    alignment: 0x20,
-                },
-                v_table: MonoVTableOffsets { vtable: 0x40 },
-            }),
-            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V1Cattrs, PointerSize::Bit64) => Some(&Self {
-                assembly: AssemblyOffsets {
-                    aname: 0x10,
-                    image: 0x58,
-                },
-                image: ImageOffsets { class_cache: 0x3D0 },
-                hash_table: HashTableOffsets {
-                    size: 0x18,
-                    table: 0x20,
-                },
-                class: ClassOffsets {
-                    parent: 0x28,
-                    image: 0x40,
-                    name: 0x48,
-                    namespace: 0x50,
-                    vtable_size: 0x18,
-                    fields: 0xA8,
-                    runtime_info: 0xF8,
-                    field_count: 0x94,
-                    next_class_cache: 0x100,
-                },
-                field: FieldInfoOffsets {
-                    name: 0x8,
-                    offset: 0x18,
-                    alignment: 0x20,
-                },
-                v_table: MonoVTableOffsets { vtable: 0x48 },
-            }),
-            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V1, PointerSize::Bit64) => Some(&Self {
-                assembly: AssemblyOffsets {
-                    aname: 0x10,
-                    image: 0x58,
-                },
-                image: ImageOffsets { class_cache: 0x3D0 },
-                hash_table: HashTableOffsets {
-                    size: 0x18,
-                    table: 0x20,
-                },
-                class: ClassOffsets {
-                    parent: 0x28,
-                    image: 0x38,
-                    name: 0x40,
-                    namespace: 0x48,
-                    vtable_size: 0x18,
-                    fields: 0xA0,
-                    runtime_info: 0xF0,
-                    field_count: 0x8C,
-                    next_class_cache: 0xF8,
-                },
-                field: FieldInfoOffsets {
-                    name: 0x8,
-                    offset: 0x18,
-                    alignment: 0x20,
-                },
-                v_table: MonoVTableOffsets { vtable: 0x48 },
-            }),
+            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V3, PointerSize::Bit64) => {
+                Some(&Self {
+                    assembly: AssemblyOffsets {
+                        aname: 0x10,
+                        image: 0x60,
+                    },
+                    image: ImageOffsets { class_cache: 0x4D0 },
+                    hash_table: HashTableOffsets {
+                        size: 0x18,
+                        table: 0x20,
+                    },
+                    class: ClassOffsets {
+                        parent: 0x28,
+                        image: 0x38,
+                        name: 0x40,
+                        namespace: 0x48,
+                        vtable_size: 0x54,
+                        fields: 0x90,
+                        runtime_info: 0xC8,
+                        field_count: 0xF8,
+                        next_class_cache: 0x100,
+                    },
+                    field: FieldInfoOffsets {
+                        name: 0x8,
+                        offset: 0x18,
+                        alignment: 0x20,
+                    },
+                    v_table: MonoVTableOffsets { vtable: 0x48 },
+                })
+            }
+            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V2, PointerSize::Bit64) => {
+                Some(&Self {
+                    assembly: AssemblyOffsets {
+                        aname: 0x10,
+                        image: 0x60,
+                    },
+                    image: ImageOffsets { class_cache: 0x4C0 },
+                    hash_table: HashTableOffsets {
+                        size: 0x18,
+                        table: 0x20,
+                    },
+                    class: ClassOffsets {
+                        parent: 0x28,
+                        image: 0x38,
+                        name: 0x40,
+                        namespace: 0x48,
+                        vtable_size: 0x54,
+                        fields: 0x90,
+                        runtime_info: 0xC8,
+                        field_count: 0xF8,
+                        next_class_cache: 0x100,
+                    },
+                    field: FieldInfoOffsets {
+                        name: 0x8,
+                        offset: 0x18,
+                        alignment: 0x20,
+                    },
+                    v_table: MonoVTableOffsets { vtable: 0x40 },
+                })
+            }
+            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V1Cattrs, PointerSize::Bit64) => {
+                Some(&Self {
+                    assembly: AssemblyOffsets {
+                        aname: 0x10,
+                        image: 0x58,
+                    },
+                    image: ImageOffsets { class_cache: 0x3D0 },
+                    hash_table: HashTableOffsets {
+                        size: 0x18,
+                        table: 0x20,
+                    },
+                    class: ClassOffsets {
+                        parent: 0x28,
+                        image: 0x40,
+                        name: 0x48,
+                        namespace: 0x50,
+                        vtable_size: 0x18,
+                        fields: 0xA8,
+                        runtime_info: 0xF8,
+                        field_count: 0x94,
+                        next_class_cache: 0x100,
+                    },
+                    field: FieldInfoOffsets {
+                        name: 0x8,
+                        offset: 0x18,
+                        alignment: 0x20,
+                    },
+                    v_table: MonoVTableOffsets { vtable: 0x48 },
+                })
+            }
+            (BinaryFormat::ELF | BinaryFormat::MachO, Version::V1, PointerSize::Bit64) => {
+                Some(&Self {
+                    assembly: AssemblyOffsets {
+                        aname: 0x10,
+                        image: 0x58,
+                    },
+                    image: ImageOffsets { class_cache: 0x3D0 },
+                    hash_table: HashTableOffsets {
+                        size: 0x18,
+                        table: 0x20,
+                    },
+                    class: ClassOffsets {
+                        parent: 0x28,
+                        image: 0x38,
+                        name: 0x40,
+                        namespace: 0x48,
+                        vtable_size: 0x18,
+                        fields: 0xA0,
+                        runtime_info: 0xF0,
+                        field_count: 0x8C,
+                        next_class_cache: 0xF8,
+                    },
+                    field: FieldInfoOffsets {
+                        name: 0x8,
+                        offset: 0x18,
+                        alignment: 0x20,
+                    },
+                    v_table: MonoVTableOffsets { vtable: 0x48 },
+                })
+            }
             _ => None,
         }
     }

src/game_engine/unity/scene_manager/component.rs

@@ -0,0 +1,40 @@
+use crate::game_engine::unity::mono;
+use crate::game_engine::unity::scene_manager::SceneManager;
+use crate::{Address, Error, Process};
+
+/// Representing a Unity Component, usually attached to a GameObject
+#[derive(Debug)]
+pub struct Component {
+    /// the base address of the component
+    pub address: Address,
+}
+
+impl Component {
+    /** Retrieves the MonoObject this Component holds */
+    pub fn get_mono_object(
+        &self,
+        process: &Process,
+        scene_manager: &SceneManager,
+    ) -> Result<mono::Object, Error> {
+        // TODO is this only true on 6000?
+        // other versions, according to how ASR currently is, do not dereference twice here
+        // NOTE: I'm like 80% sure the following is true
+        process
+            // class ScriptingGCHandle m_MonoReference
+            // See https://gist.github.com/just-ero/92457b51baf85bd1e5b8c87de8c9835e#file-object-hpp-L18
+            // In Mono this is a MonoObjectHandle, which is a MonoObject**
+            // MonoObject **__raw
+            // See https://github.com/mono/mono/blob/0f53e9e151d92944cacab3e24ac359410c606df6/mono/metadata/handle-decl.h#L72
+            .read_pointer(
+                self.address + scene_manager.offsets.scripting_object_handle,
+                scene_manager.pointer_size,
+            )
+            .ok()
+            .filter(|val| !val.is_null())
+            // MonoObject *__raw
+            .and_then(|addr| process.read_pointer(addr, scene_manager.pointer_size).ok())
+            .filter(|val| !val.is_null())
+            .map(|address| mono::Object { address })
+            .ok_or(Error {})
+    }
+}