Linked up more useful common structs

Author: monkeyman192

nmspy/common.py

@@ -6,6 +6,16 @@
 class GameData:
     GcApplication: nms.cGcApplication = None  # type: ignore
 
+    @property
+    def environment(self) -> Optional[nms.cGcEnvironment]:
+        if (sim := self.simulation) is not None:
+            return sim.mEnvironment
+
+    @property
+    def player_environment(self) -> Optional[nms.cGcPlayerEnvironment]:
+        if (env := self.environment) is not None:
+            return env.mPlayerEnvironment
+
     @property
     def game_state(self) -> Optional[nms.cGcGameState]:
         if self.GcApplication is not None:

nmspy/data/enums/__init__.py

@@ -6,6 +6,7 @@
     StateEnum,
     eStormState,
     eLanguageRegion,
+    EnvironmentLocation,
 )
 
 # The following list is auto-generated.

nmspy/data/enums/internal_enums.py

@@ -77,3 +77,23 @@ class eLanguageRegion(IntEnum):
     SimplifiedChinese = 0xE
     TencentChinese = 0xF
     Korean = 0x10
+
+
+class EnvironmentLocation():
+    class Enum(IntEnum):
+        None_ = 0x0
+        Default = 0x1
+        SpaceStation = 0x2
+        PlanetOnFoot = 0x3
+        PlanetInShip = 0x4
+        PlanetInVehicle = 0x5
+        Underwater = 0x6
+        Cave = 0x7
+        IndoorInBase = 0x8
+        Freighter = 0x9
+        FreighterInternals = 0xA
+        AbandonedFreighter = 0xB
+        InFleet = 0xC
+        InSpaceObject = 0xD
+        Nexus = 0xE
+        Anomaly = 0xF

nmspy/data/types.py

@@ -613,8 +613,59 @@ def Update(
     ): ...
 
 
+@partial_struct
+class cGcPlayerEnvironment(Structure):
+    mPlayerTM: Annotated[basic.cTkMatrix34, Field(basic.cTkMatrix34, 0x0)]
+    mUp: Annotated[basic.Vector3f, Field(basic.Vector3f, 0x40)]
+
+    # Found below the call to cTkDynamicGravityControl::GetGravity in cGcPlayerEnvironment::Update
+    miNearestPlanetIndex: Annotated[int, Field(c_uint32, 0x2BC)]
+    mfDistanceFromPlanet: Annotated[float, Field(c_float, 0x2C0)]
+    mfNearestPlanetSealevel: Annotated[float, Field(c_float, 0x2C4)]
+    mNearestPlanetPos: Annotated[basic.Vector3f, Field(basic.Vector3f, 0x2D0)]
+    mbInsidePlanetAtmosphere: Annotated[bool, Field(c_bool, 0x2EC)]
+    meLocation: Annotated[
+        enums.EnvironmentLocation.Enum,
+        Field(c_enum32[enums.EnvironmentLocation.Enum], 0x458)
+    ]
+    meLocationStable: Annotated[
+        enums.EnvironmentLocation.Enum,
+        Field(c_enum32[enums.EnvironmentLocation.Enum], 0x464)
+    ]
+
+    @function_hook("48 83 EC ? 80 B9 ? ? ? ? ? C6 04 24")
+    def IsOnboardOwnFreighter(
+        self, this: "_Pointer[cGcPlayerEnvironment]"
+    ) -> c_bool: ...
+
+    @function_hook("8B 81 ? ? ? ? 83 E8 ? 83 F8 ? 0F 96 C0 C3 48 83 EC")
+    def IsOnPlanet(self, this: "_Pointer[cGcPlayerEnvironment]") -> c_bool: ...
+
+    @function_hook("48 8B C4 F3 0F 11 48 ? 55 53 41 54")
+    def Update(
+        self,
+        this: "_Pointer[cGcPlayerEnvironment]",
+        lfTimeStep: Annotated[float, c_float],
+    ): ...
+
+
+@partial_struct
+class cGcEnvironment(Structure):
+    # Passed into multiple cGcPlayerEnvironment methods.
+    mPlayerEnvironment: Annotated[cGcPlayerEnvironment, 0x8A0]
+
+    @function_hook(
+        "48 8B C4 48 89 48 ? 55 53 56 57 41 54 41 55 41 56 41 57 48 8D A8 ? ? ? ? 48 81 EC ? ? ? ? 0F 29 70 ? 4C 8B E9"
+    )
+    def UpdateRender(self, this: "_Pointer[cGcEnvironment]"):
+        # TODO: There could be a few good functions to get which are called in here...
+        ...
+
+
 @partial_struct
 class cGcSimulation(Structure):
+    # Found in cGcSimulation::Update. Passed into cGcEnvironment::Update.
+    mEnvironment: Annotated[cGcEnvironment, 0xAF790]
     mPlayer: Annotated[cGcPlayer, 0x24DE40]
     # Found in cGcSimulation::Update. Passed into cGcSolarSystem::Update.
     mpSolarSystem: Annotated[_Pointer[cGcSolarSystem], 0x24C670]
@@ -885,34 +936,6 @@ def UpdateGravityPoint(
 ]
 
 
-@partial_struct
-class cGcPlayerEnvironment(Structure):
-    mPlayerTM: Annotated[basic.cTkMatrix34, Field(basic.cTkMatrix34, 0x0)]
-    mUp: Annotated[basic.Vector3f, Field(basic.Vector3f, 0x40)]
-
-    # Found below the call to cTkDynamicGravityControl::GetGravity in cGcPlayerEnvironment::Update
-    miNearestPlanetIndex: Annotated[int, Field(c_uint32, 0x2BC)]
-    mfDistanceFromPlanet: Annotated[float, Field(c_float, 0x2C0)]
-    mfNearestPlanetSealevel: Annotated[float, Field(c_float, 0x2C4)]
-    mNearestPlanetPos: Annotated[basic.Vector3f, Field(basic.Vector3f, 0x2D0)]
-    mbInsidePlanetAtmosphere: Annotated[bool, Field(c_bool, 0x2EC)]
-
-    @function_hook("48 83 EC ? 80 B9 ? ? ? ? ? C6 04 24")
-    def IsOnboardOwnFreighter(
-        self, this: "_Pointer[cGcPlayerEnvironment]"
-    ) -> c_bool: ...
-
-    @function_hook("8B 81 ? ? ? ? 83 E8 ? 83 F8 ? 0F 96 C0 C3 48 83 EC")
-    def IsOnPlanet(self, this: "_Pointer[cGcPlayerEnvironment]") -> c_bool: ...
-
-    @function_hook("48 8B C4 F3 0F 11 48 ? 55 53 41 54")
-    def Update(
-        self,
-        this: "_Pointer[cGcPlayerEnvironment]",
-        lfTimeStep: Annotated[float, c_float],
-    ): ...
-
-
 class Engine:
     @static_function_hook("40 53 48 83 EC ? 44 8B D1 44 8B C1")
     @staticmethod
@@ -1156,15 +1179,6 @@ def StateChange(
     ): ...
 
 
-class cGcEnvironment(Structure):
-    @function_hook(
-        "48 8B C4 48 89 48 ? 55 53 56 57 41 54 41 55 41 56 41 57 48 8D A8 ? ? ? ? 48 81 EC ? ? ? ? 0F 29 70 ? 4C 8B E9"
-    )
-    def UpdateRender(self, this: "_Pointer[cGcEnvironment]"):
-        # TODO: There could be a few good functions to get which are called in here...
-        ...
-
-
 class cGcPlayerNotifications(Structure):
     @function_hook("48 89 5C 24 ? 48 89 74 24 ? 57 48 81 EC ? ? ? ? 44 8B 81")
     def AddTimedMessage(