PhysicalMaterialPartComponent.md

Class: PhysicalMaterialPartComponent

• Types
  • <ComponentProps>
  • <PhysicalMaterialPartComponentProps>
• Constructors
  • new PhysicalMaterialPartComponent(props)
  • PhysicalMaterialPartComponent.fromBinary(reader, version)
• Properties
  • hash
  • name
  • version
  • materialHash
• Methods
  • toBinary(version?)
  • write(writer, version?)

Types

<ComponentProps>

See <ComponentProps>

---

<PhysicalMaterialPartComponentProps>

A portion of the configuration object to pass to the PhysicalMaterialPartComponent constructor.

type PhysicalMaterialPartComponentPropsV1 = {
  materialHash?: number | undefined;
};

type PhysicalMaterialPartComponentProps = PhysicalMaterialPartComponentPropsV1;

Since v1

• materialHash (optional, default 1) <PhysicalMaterialPartHash>

Constructors

new PhysicalMaterialPartComponent(props)

Creates a versioned PhysicalMaterialPart component.

• props <ComponentProps & PhysicalMaterialPartComponentProps> Configuration of the component to create.
• Returns: <PhysicalMaterialPartComponent>

import { PhysicalMaterialPartComponent } from 'att-string-transcoder';

const componentVersion = 1;
const component = new PhysicalMaterialPartComponent({ version: componentVersion });

---

PhysicalMaterialPartComponent.fromBinary(reader, version)

See Component.fromBinary(reader, version)

Properties

Note that the following properties are sorted in order of appearance when decoding component binary data.

hash

See Component.hash

---

name

See Component.name

---

version

See Component.version

---

materialHash

The hash of the physical material of the prefab this component is attached to.

• Since: v1
• <PhysicalMaterialPartHash>

import { PhysicalMaterialPartComponent } from 'att-string-transcoder';

const componentVersion = 1;
const component = new PhysicalMaterialPartComponent({ version: componentVersion });

const materialHash = component.materialHash;
// `materialHash` is `1`

Methods

toBinary(version?)

See Component.toBinary(version?)

---

write(writer, version?)

See Component.write(writer, version?)