Add getMaterial helper method

Author: mdingena

docs/Entity.md

@@ -13,6 +13,7 @@
   - [`components`](#components)
 - [Methods](#methods)
   - [`addComponent(component)`](#addcomponentcomponent)
+  - [`getMaterial()`](#getmaterial)
   - [`removeAllComponents()`](#removeallcomponents)
   - [`removeComponent(componentArg)`](#removecomponentcomponentarg)
   - [`toBinary(componentVersions)`](#tobinarycomponentversions)
@@ -187,6 +188,23 @@ entity.addComponent(component);
 
 ---
 
+### `getMaterial()`
+
+Gets the entity's physical material.
+
+- Returns: [`<PhysicalMaterialPartHash>`](../src/types/PhysicalMaterialPartHash.ts)
+
+```ts
+import { Entity, PhysicalMaterialPartHash } from 'att-string-transcoder';
+
+const entity = new Entity<'Standard_Side_Pouch_Attachment'>('standard_sidePouch_backPin_L1_7968');
+
+const materialHash = entity.getMaterial();
+const materialName = PhysicalMaterialPartHash[materialHash];
+```
+
+---
+
 ### `removeAllComponents()`
 
 Removes all components on this entity.

src/Entity.test.ts

@@ -10,6 +10,7 @@ import { NetworkRigidbodyComponent } from './components/NetworkRigidbodyComponen
 import { PhysicalMaterialPartComponent } from './components/PhysicalMaterialPartComponent.js';
 import { UnsupportedComponent } from './components/UnsupportedComponent.js';
 import { ComponentHash } from './types/ComponentHash.js';
+import { PhysicalMaterialPartHash } from './types/PhysicalMaterialPartHash.js';
 
 describe('new Entity()', () => {
   describe('when given the required props', () => {
@@ -175,6 +176,36 @@ describe('Entity.fromBinary()', () => {
   });
 });
 
+describe('Entity.getMaterial()', () => {
+  describe('when the entity has no PhysicalMaterialPart component', () => {
+    it('returns materialHash of zero', () => {
+      const entity = new Entity<'Standard_Side_Pouch_Attachment'>('standard_sidePouch_backPin_L1_7968');
+      delete entity.components.PhysicalMaterialPart;
+
+      const materialHash = entity.getMaterial();
+
+      expect(materialHash).toStrictEqual(0);
+    });
+  });
+
+  describe('when the prefab has a PhysicalMaterialPart component with materialHash', () => {
+    it('returns the stored isKinematic', () => {
+      const entity = new Entity<'Standard_Side_Pouch_Attachment'>('standard_sidePouch_backPin_L1_7968', {
+        components: {
+          PhysicalMaterialPart: new PhysicalMaterialPartComponent({
+            version: 1,
+            materialHash: PhysicalMaterialPartHash.EvinonSteelAlloy
+          })
+        }
+      });
+
+      const materialHash = entity.getMaterial();
+
+      expect(materialHash).toStrictEqual(31502);
+    });
+  });
+});
+
 describe('Entity.removeAllComponents()', () => {
   it('removes all components from the entity', () => {
     const entity = new Entity<'Standard_Side_Pouch_Attachment'>('standard_sidePouch_backPin_L1_7968', {

src/Entity.ts

@@ -11,6 +11,7 @@ import type { UnsupportedPrefabComponents } from './types/UnsupportedPrefabCompo
 import { BinaryWriter } from './BinaryWriter.js';
 import { ATTPrefabs } from './types/ATTPrefabs.js';
 import { ComponentHash } from './types/ComponentHash.js';
+import { PhysicalMaterialPartHash } from './types/PhysicalMaterialPartHash.js';
 import { readComponents } from './utils/readComponents.js';
 import { writeComponents } from './utils/writeComponents.js';
 
@@ -184,6 +185,23 @@ export class Entity<TPrefabName extends ATTPrefabName> {
     });
   }
 
+  /**
+   * Gets the entity's physical material.
+   *
+   * @since v3.1.0
+   *
+   * @example
+   * import { Entity, PhysicalMaterialPartHash } from 'att-string-transcoder';
+   *
+   * const entity = new Entity<'Standard_Side_Pouch_Attachment'>('standard_sidePouch_backPin_L1_7968');
+   *
+   * const materialHash = entity.getMaterial();
+   * const materialName = PhysicalMaterialPartHash[materialHash];
+   */
+  getMaterial(): PhysicalMaterialPartHash {
+    return this.components.PhysicalMaterialPart?.materialHash ?? 0;
+  }
+
   /**
    * Removes all components on this entity.
    *