DoorComponent.md

Class: DoorComponent

• Types
  • <ComponentProps>
  • <DoorComponentProps>
• Constructors
  • new DoorComponent(props)
  • DoorComponent.fromBinary(reader, version)
• Properties
  • hash
  • name
  • version
  • isOpen
• Methods
  • toBinary(version?)
  • write(writer, version?)

Types

<ComponentProps>

See <ComponentProps>

---

<DoorComponentProps>

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

type DoorComponentPropsV1 = {
  isOpen?: number | undefined;
};

type DoorComponentProps = DoorComponentPropsV1;

Since v1

• isOpen (optional, default false) <boolean>

Constructors

new DoorComponent(props)

Creates a versioned Door component.

• props <ComponentProps & DoorComponentProps> Configuration of the component to create.
• Returns: <DoorComponent>

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

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

---

DoorComponent.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

---

isOpen

Reveals the open state of this component's prefab

• Since: v1
• <boolean>

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

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

const isOpen = component.isOpen;
// `isOpen` is `false`

Methods

toBinary(version?)

See Component.toBinary(version?)

---

write(writer, version?)

See Component.write(writer, version?)